@novicov/swagger_petstore

This_is_a_sample_server_Petstore_server___You_can_find_out_more_about_Swagger_at__httpswagger_io_httpswagger_io_or_on__irc_freenode_net_swagger_httpswagger_ioirc___For_this_sample_you_can_use_the_api_key_special_key_to_test_the_authorization_filters_

Usage no npm install needed!

<script type="module">
  import novicovSwaggerPetstore from 'https://cdn.skypack.dev/@novicov/swagger_petstore';
</script>

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: 2019-04-24T16:07:29.784+03: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/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.

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

api.addPet(body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

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

Documentation for Authorization

petstore_auth

api_key

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