swagger-petstore
v1.0.0
Published
This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authori
Downloads
5
Readme
swagger-petstore
SwaggerPetstore - JavaScript client for swagger-petstore
This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key
to test the authorization filters.
This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build date: 2016-04-26T08:49:51.951-06:00
- Build package: class io.swagger.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 swagger-petstore --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/YOUR_GIT_REPO_ID then install it via:
npm install YOUR_USERNAME/YOUR_GIT_REPO_ID --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.
Getting Started
Please follow the installation instruction and execute the following JS code:
var SwaggerPetstore = require('swagger-petstore');
var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
var api = new SwaggerPetstore.PetApi()
var body = new SwaggerPetstore.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 ------------ | ------------- | ------------- | ------------- SwaggerPetstore.PetApi | addPet | POST /pet | Add a new pet to the store SwaggerPetstore.PetApi | deletePet | DELETE /pet/{petId} | Deletes a pet SwaggerPetstore.PetApi | findPetsByStatus | GET /pet/findByStatus | Finds Pets by status SwaggerPetstore.PetApi | findPetsByTags | GET /pet/findByTags | Finds Pets by tags SwaggerPetstore.PetApi | getPetById | GET /pet/{petId} | Find pet by ID SwaggerPetstore.PetApi | updatePet | PUT /pet | Update an existing pet SwaggerPetstore.PetApi | updatePetWithForm | POST /pet/{petId} | Updates a pet in the store with form data SwaggerPetstore.PetApi | uploadFile | POST /pet/{petId}/uploadImage | uploads an image SwaggerPetstore.StoreApi | deleteOrder | DELETE /store/order/{orderId} | Delete purchase order by ID SwaggerPetstore.StoreApi | getInventory | GET /store/inventory | Returns pet inventories by status SwaggerPetstore.StoreApi | getOrderById | GET /store/order/{orderId} | Find purchase order by ID SwaggerPetstore.StoreApi | placeOrder | POST /store/order | Place an order for a pet SwaggerPetstore.UserApi | createUser | POST /user | Create user SwaggerPetstore.UserApi | createUsersWithArrayInput | POST /user/createWithArray | Creates list of users with given input array SwaggerPetstore.UserApi | createUsersWithListInput | POST /user/createWithList | Creates list of users with given input array SwaggerPetstore.UserApi | deleteUser | DELETE /user/{username} | Delete user SwaggerPetstore.UserApi | getUserByName | GET /user/{username} | Get user by user name SwaggerPetstore.UserApi | loginUser | GET /user/login | Logs user into the system SwaggerPetstore.UserApi | logoutUser | GET /user/logout | Logs out current logged in user session SwaggerPetstore.UserApi | updateUser | PUT /user/{username} | Updated user
Documentation for Models
- SwaggerPetstore.ApiResponse
- SwaggerPetstore.Category
- SwaggerPetstore.Order
- SwaggerPetstore.Pet
- SwaggerPetstore.Tag
- SwaggerPetstore.User
Documentation for Authorization
petstore_auth
- Type: OAuth
- Flow: implicit
- Authorization URL: http://petstore.swagger.io/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