swagger_petstore___open_api_30

SwaggerPetstoreOpenApi30 - JavaScript client for swagger_petstore___open_api_30 This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at https://swagger.io. In the third iteration of the pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3. If you're looking for the Swagger 2.0/OAS 2.0 version of Petstore, then click here. Alternatively, you can load via the Edit > Load Petstore OAS 2.0 menu option! Some useful links: - The Pet Store repository - The source API definition for the Pet Store This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.11
• Package version: 1.0.11
• Build package: io.swagger.codegen.v3.generators.javascript.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___open_api_30 --save

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

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 SwaggerPetstoreOpenApi30 = require('swagger_petstore___open_api_30');
var defaultClient = SwaggerPetstoreOpenApi30.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 SwaggerPetstoreOpenApi30.PetApi()
var body = new SwaggerPetstoreOpenApi30.Pet(); // {Pet} Create a new pet in the store
var id = 789; // {Number} 
var name = "name_example"; // {String} 
var category = new SwaggerPetstoreOpenApi30.Category(); // {Category} 
var photoUrls = ["photoUrls_example"]; // {[String]} 
var tags = [new SwaggerPetstoreOpenApi30.Tag()]; // {[Tag]} 
var status = "status_example"; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addPet(body, id, name, category, photoUrls, tags, status, callback);

Documentation for API Endpoints

All URIs are relative to https://petstore3.swagger.io/api/v3

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

Documentation for Models

• SwaggerPetstoreOpenApi30.Address
• SwaggerPetstoreOpenApi30.ApiResponse
• SwaggerPetstoreOpenApi30.Category
• SwaggerPetstoreOpenApi30.Customer
• SwaggerPetstoreOpenApi30.Order
• SwaggerPetstoreOpenApi30.Pet
• SwaggerPetstoreOpenApi30.Tag
• SwaggerPetstoreOpenApi30.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: https://petstore3.swagger.io/oauth/authorize
• Scopes:
  • :