Getting Started with Swagger Petstore

Introduction

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.

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

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install rose-nielsen-sdk==0.1.5

You can also view the package at: https://pypi.python.org/pypi/rose-nielsen-sdk/0.1.5

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:

The API client can be initialized as follows:

from swaggerpetstore.configuration import Environment
from swaggerpetstore.http.auth.api_key import ApiKeyCredentials
from swaggerpetstore.http.auth.http_basic import HttpBasicCredentials
from swaggerpetstore.http.auth.petstore_auth import PetstoreAuthCredentials
from swaggerpetstore.models.o_auth_scope_petstore_auth_enum import OAuthScopePetstoreAuthEnum
from swaggerpetstore.swaggerpetstore_client import SwaggerpetstoreClient

client = SwaggerpetstoreClient(
    test_header='TestHeaderDefaultValue',
    api_key_credentials=ApiKeyCredentials(
        api_key='api_key'
    ),
    http_basic_credentials=HttpBasicCredentials(
        username='username',
        passwprd='passwprd'
    ),
    petstore_auth_credentials=PetstoreAuthCredentials(
        o_auth_client_id='OAuthClientId',
        o_auth_redirect_uri='OAuthRedirectUri',
        o_auth_scopes=[
            OAuthScopePetstoreAuthEnum.READPETS,
            OAuthScopePetstoreAuthEnum.WRITEPETS
        ]
    ),
    environment=Environment.PRODUCTION
)

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• api_key (Custom Header Signature)
• httpBasic (Basic Authentication)
• petstore_auth (OAuth 2 Implicit Grant)

List of APIs

• Pet
• Store
• User

SDK Infrastructure

Configuration

• ProxySettings

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime