/openapi-gen-test

Primary LanguageRuby

open_api_petstore

OpenApiPetstore - JavaScript client for open_api_petstore 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.0.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 open_api_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 open_api_petstore from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('open_api_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/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/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, 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 OpenApiPetstore = require('open_api_petstore');

var defaultClient = OpenApiPetstore.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 OpenApiPetstore.PetApi()
var pet = new OpenApiPetstore.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(pet, callback);

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Class Method HTTP request Description
OpenApiPetstore.PetApi addPet POST /pet Add a new pet to the store
OpenApiPetstore.PetApi deletePet DELETE /pet/{petId} Deletes a pet
OpenApiPetstore.PetApi findPetsByStatus GET /pet/findByStatus Finds Pets by status
OpenApiPetstore.PetApi findPetsByTags GET /pet/findByTags Finds Pets by tags
OpenApiPetstore.PetApi getPetById GET /pet/{petId} Find pet by ID
OpenApiPetstore.PetApi updatePet PUT /pet Update an existing pet
OpenApiPetstore.PetApi updatePetWithForm POST /pet/{petId} Updates a pet in the store with form data
OpenApiPetstore.PetApi uploadFile POST /pet/{petId}/uploadImage uploads an image
OpenApiPetstore.StoreApi deleteOrder DELETE /store/order/{orderId} Delete purchase order by ID
OpenApiPetstore.StoreApi getInventory GET /store/inventory Returns pet inventories by status
OpenApiPetstore.StoreApi getOrderById GET /store/order/{orderId} Find purchase order by ID
OpenApiPetstore.StoreApi placeOrder POST /store/order Place an order for a pet
OpenApiPetstore.UserApi createUser POST /user Create user
OpenApiPetstore.UserApi createUsersWithArrayInput POST /user/createWithArray Creates list of users with given input array
OpenApiPetstore.UserApi createUsersWithListInput POST /user/createWithList Creates list of users with given input array
OpenApiPetstore.UserApi deleteUser DELETE /user/{username} Delete user
OpenApiPetstore.UserApi getUserByName GET /user/{username} Get user by user name
OpenApiPetstore.UserApi loginUser GET /user/login Logs user into the system
OpenApiPetstore.UserApi logoutUser GET /user/logout Logs out current logged in user session
OpenApiPetstore.UserApi updateUser PUT /user/{username} Updated user

Documentation for Models

Documentation for Authorization

api_key

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

petstore_auth