swagger-petstore-3-sdk v1.0.4

Getting Started with Swagger Petstore - OpenAPI 3.0

Introduction

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

Find out more about Swagger: http://swagger.io

Install the Package

Run the following command from your project directory to install the package from npm:

npm install swagger-petstore-3-sdk@1.0.4

For additional package details, see the Npm page for the swagger-petstore-3-sdk@1.0.4 npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

HttpClientOptions

RetryConfiguration

The API client can be initialized as follows:

const client = new Client({
  timeout: 0,
  apiKey: 'api_key',
});

Authorization

This API uses Custom Header Signature.

List of APIs

• Pet
• Store
• User

Classes Documentation

• ApiResponse
• ApiError