petstore-test-sdk

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

Install the gem from the command line:

gem install petstore-test-sdk -v 1.0.0

Or add the gem to your Gemfile and run bundle:

gem 'petstore-test-sdk', '1.0.0'

For additional gem details, see the RubyGems page for the petstore-test-sdk gem.

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
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.
custom_header_authentication_credentials	CustomHeaderAuthenticationCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

client = SwaggerPetstoreOpenApi30::Client.new(
  custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
    api_key: 'api_key'
  )
)

Authorization

This API uses the following authentication schemes.

• api_key (Custom Header Signature)

List of APIs

• Pet
• Store
• User

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest