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.

Some useful links:

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

Install the Package

Install the gem from the command line:

gem install package-test-ruby -v 1.0.3

Or add the gem to your Gemfile and run bundle:

gem 'package-test-ruby', '1.0.3'

For additional gem details, see the RubyGems page for the package-test-ruby gem.

IRB Console Usage

You can explore the SDK interactively using IRB in two ways

1. Use IRB with Installed Gem

Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.

irb

Now you can load the SDK in the IRB

require 'swagger_petstore_open_api30'
include SwaggerPetstoreOpenApi30

2. Use IRB within SDK

Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.

cd path/to/swagger_petstore_open_api30

Now you can start the preconfigured irb console by running the following command

ruby bin/console

Note: This automatically loads the SDK from lib/

Test the SDK

To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:

rake

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
environment Environment The API environment.
Default: Environment.PRODUCTION
connection Faraday::Connection The Faraday connection object passed by the SDK user for making requests
adapter Faraday::Adapter The Faraday adapter object passed by the SDK user for performing http requests
timeout Float The value to use for connection timeout.
Default: 60
max_retries Integer The number of times to retry an endpoint call if it fails.
Default: 0
retry_interval Float Pause in seconds between retries.
Default: 1
backoff_factor Float The amount to multiply each successive retry's interval amount by in order to provide backoff.
Default: 2
retry_statuses Array A list of HTTP statuses to retry.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array A list of HTTP methods to retry.
Default: %i[get put]
http_callback HttpCallBack The Http CallBack allows defining callables for pre and post API calls.
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
petstore_auth_credentials PetstoreAuthCredentials The credential object for OAuth 2 Implicit Grant
api_key_credentials ApiKeyCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

require 'swagger_petstore_open_api30'
include SwaggerPetstoreOpenApi30

client = Client.new(
  petstore_auth_credentials: PetstoreAuthCredentials.new(
    o_auth_client_id: 'OAuthClientId',
    o_auth_redirect_uri: 'OAuthRedirectUri',
    o_auth_scopes: [
      OAuthScopePetstoreAuthEnum::WRITEPETS,
      OAuthScopePetstoreAuthEnum::READPETS
    ]
  ),
  api_key_credentials: ApiKeyCredentials.new(
    api_key: 'api_key'
  ),
  environment: Environment::PRODUCTION
)

Environment-Based Client Initialization

require 'swagger_petstore_open_api30'
include SwaggerPetstoreOpenApi30

# Create client from environment
client = Client.from_env

See the Environment-Based Client Initialization section for details.

Environments

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

Fields

Name Description
PRODUCTION Default

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities