zahra-package-test

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

Install the gem from the command line:

gem install zahra-package-test -v 1.1.2

Or add the gem to your Gemfile and run bundle:

gem 'zahra-package-test', '1.1.2'

For additional gem details, see the RubyGems page for the zahra-package-test 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
test_header	String	This is a test header Default: 'TestHeaderDefaultValue'
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.
api_key_credentials	ApiKeyCredentials	The credential object for Custom Header Signature
http_basic_credentials	HttpBasicCredentials	The credential object for Basic Authentication
petstore_auth_credentials	PetstoreAuthCredentials	The credential object for OAuth 2 Implicit Grant

The API client can be initialized as follows:

client = SwaggerPetstore::Client.new(
  test_header: 'TestHeaderDefaultValue',
  api_key_credentials: ApiKeyCredentials.new(
    api_key: 'api_key'
  ),
  http_basic_credentials: HttpBasicCredentials.new(
    username: 'username',
    passwprd: 'passwprd'
  ),
  petstore_auth_credentials: PetstoreAuthCredentials.new(
    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

Name	Description
production	Default
environment2	-
environment3	-

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

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest