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 package: 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

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

Finally, switch to the directory you want to use your swagger_petstore from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('swagger_petstore') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/swagger_petstore then install it via:

    npm install YOUR_USERNAME/swagger_petstore --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, that's to say your javascript file where you actually use this library):

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 SwaggerPetstore = require('swagger_petstore');

var defaultClient = SwaggerPetstore.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 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 https://petstore.swagger.io/v2

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- SwaggerPetstore.PetApi | addPet | POST /pet | Add a new pet to the store SwaggerPetstore.PetApi | findPetsByStatus | GET /pet | Finds Pets by status SwaggerPetstore.PetApi | updatePet | PUT /pet | Update an existing pet 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

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

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