Skip to main content

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

The package is compatible with Python versions 3 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install petstore-test-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/petstore-test-sdk/1.0.0

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt
pytest

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
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']
custom_header_authentication_credentials CustomHeaderAuthenticationCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

client = Swaggerpetstoreopenapi30Client(
    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
        api_key='api_key'
    ),
    environment=Environment.PRODUCTION
)

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation

Metadata

Release files for petstore-test-sdk 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for petstore-test-sdk 1.0.0
File Size Uploaded Provenance Actions
petstore_test_sdk-1.0.0.tar.gz 15.0 kB Without provenance Details for petstore_test_sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for petstore-test-sdk 1.0.0
File Interpreter ABI Platform Actions
petstore_test_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for petstore_test_sdk-1.0.0-py3-none-any.whl

Total release size: 45.3 kB

Release files / petstore_test_sdk-1.0.0.tar.gz

Download URL petstore_test_sdk-1.0.0.tar.gz
Size 15.0 kB
Tags Source
SHA-256 checksum
How to use checksums
914af7e07632688540380859cd5503c5c5dcb21d89842c83ec776ea5cab00be5
BLAKE2b-256 checksum
How to use checksums
29a965fca08ca0ecc52f24b1014099f2927de1a699e3d450ca25739cd1c928d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.13

Release files / petstore_test_sdk-1.0.0-py3-none-any.whl

Download URL petstore_test_sdk-1.0.0-py3-none-any.whl
Size 30.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0c532af098167d04d83975710a5e1820ddccd40d408f7e1470f86248b8f9f12b
BLAKE2b-256 checksum
How to use checksums
f002d6e80c67b0d254c0d18662f483ed9ece5864fc5cbea3c8455aec7e6cb9bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.13

Security for petstore-test-sdk 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page