swagger-petstore-3-sdk
v1.0.4
Published
This is a sample Pet Store Server based on the OpenAPI 3.0 specification.
Downloads
206
Maintainers
Readme
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:
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 [email protected]
For additional package details, see the Npm page for the [email protected] npm.
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| timeout
| number
| Timeout for API calls.Default: 0
|
| httpClientOptions
| Partial<HttpClientOptions>
| Stable configurable http client options. |
| unstableHttpClientOptions
| any
| Unstable configurable http client options. |
| apiKey
| string
| |
HttpClientOptions
| Parameter | Type | Description |
| --- | --- | --- |
| timeout
| number
| Timeout in milliseconds. |
| httpAgent
| any
| Custom http agent to be used when performing http requests. |
| httpsAgent
| any
| Custom https agent to be used when performing http requests. |
| retryConfig
| Partial<RetryConfiguration>
| Configurations to retry requests. |
RetryConfiguration
| Parameter | Type | Description |
| --- | --- | --- |
| maxNumberOfRetries
| number
| Maximum number of retries. Default: 0
|
| retryOnTimeout
| boolean
| Whether to retry on request timeout. Default: true
|
| retryInterval
| number
| Interval before next retry. Used in calculation of wait time for next request in case of failure. Default: 1
|
| maximumRetryWaitTime
| number
| Overall wait time for the requests getting retried. Default: 0
|
| backoffFactor
| number
| Used in calculation of wait time for next request in case of failure. Default: 2
|
| httpStatusCodesToRetry
| number[]
| Http status codes to retry against. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
|
| httpMethodsToRetry
| HttpMethod[]
| Http methods to retry against. Default: ['GET', 'PUT']
|
The API client can be initialized as follows:
const client = new Client({
timeout: 0,
apiKey: 'api_key',
});
Authorization
This API uses Custom Header Signature
.