js-pack-test-maven v1.3.0
js-pack-test-maven
JsPackTestMaven - JavaScript client for js-pack-test-maven
This is a sample server Petstore server. For this sample, you can use the api key special-key
to test the authorization filters.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.3.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install js-pack-test-maven --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your js-pack-test-maven from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/YOUR_USERNAME/js-pack-test-maven then install it via:
npm install YOUR_USERNAME/js-pack-test-maven --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var JsPackTestMaven = require('js-pack-test-maven');
var defaultClient = JsPackTestMaven.ApiClient.instance;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
var api = new JsPackTestMaven.PetApi()
var body = new JsPackTestMaven.Pet(); // {Pet} Pet object that needs to be added to the store
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.addPet(body, callback);
Documentation for API Endpoints
All URIs are relative to http://petstore.swagger.io/v2
Class | Method | HTTP request | Description |
---|---|---|---|
JsPackTestMaven.PetApi | addPet | POST /pet | Add a new pet to the store |
JsPackTestMaven.PetApi | deletePet | DELETE /pet/{petId} | Deletes a pet |
JsPackTestMaven.PetApi | findPetsByStatus | GET /pet/findByStatus | Finds Pets by status |
JsPackTestMaven.PetApi | findPetsByTags | GET /pet/findByTags | Finds Pets by tags |
JsPackTestMaven.PetApi | getPetById | GET /pet/{petId} | Find pet by ID |
JsPackTestMaven.PetApi | updatePet | PUT /pet | Update an existing pet |
JsPackTestMaven.PetApi | updatePetWithForm | POST /pet/{petId} | Updates a pet in the store with form data |
JsPackTestMaven.PetApi | uploadFile | POST /pet/{petId}/uploadImage | uploads an image |
JsPackTestMaven.StoreApi | deleteOrder | DELETE /store/order/{orderId} | Delete purchase order by ID |
JsPackTestMaven.StoreApi | getInventory | GET /store/inventory | Returns pet inventories by status |
JsPackTestMaven.StoreApi | getOrderById | GET /store/order/{orderId} | Find purchase order by ID |
JsPackTestMaven.StoreApi | placeOrder | POST /store/order | Place an order for a pet |
JsPackTestMaven.UserApi | createUser | POST /user | Create user |
JsPackTestMaven.UserApi | createUsersWithArrayInput | POST /user/createWithArray | Creates list of users with given input array |
JsPackTestMaven.UserApi | createUsersWithListInput | POST /user/createWithList | Creates list of users with given input array |
JsPackTestMaven.UserApi | deleteUser | DELETE /user/{username} | Delete user |
JsPackTestMaven.UserApi | getUserByName | GET /user/{username} | Get user by user name |
JsPackTestMaven.UserApi | loginUser | GET /user/login | Logs user into the system |
JsPackTestMaven.UserApi | logoutUser | GET /user/logout | Logs out current logged in user session |
JsPackTestMaven.UserApi | updateUser | PUT /user/{username} | Updated user |
Documentation for Models
- JsPackTestMaven.ApiResponse
- JsPackTestMaven.Category
- JsPackTestMaven.Order
- JsPackTestMaven.Pet
- JsPackTestMaven.Tag
- JsPackTestMaven.User
Documentation for Authorization
Authentication schemes defined for the API:
petstore_auth
- Type: OAuth
- Flow: implicit
- Authorization URL: http://petstore.swagger.io/api/oauth/dialog
- Scopes:
- write:pets: modify pets in your account
- read:pets: read your pets
api_key
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago