README

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

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "pet-store/petstore-sdk:1.0.0"

Or add it to the composer.json file manually as given below:

"require": {
    "pet-store/petstore-sdk": "1.0.0"
}

You can also view the package at: https://packagist.org/packages/pet-store/petstore-sdk#1.0.0

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

First install the dependencies using composer including the require-dev dependencies.
Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

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
timeout	`int`	Timeout for API calls in seconds. Default: `0`
enableRetries	`bool`	Whether to enable retries and backoff feature. Default: `false`
numberOfRetries	`int`	The number of retries to make. Default: `0`
retryInterval	`float`	The retry time interval between the endpoint calls. Default: `1`
backOffFactor	`float`	Exponential backoff factor to increase interval between retries. Default: `2`
maximumRetryWaitTime	`int`	The maximum wait time in seconds for overall retrying requests. Default: `0`
retryOnTimeout	`bool`	Whether to retry on request timeout. Default: `true`
httpStatusCodesToRetry	`array`	Http status codes to retry against. Default: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524`
httpMethodsToRetry	`array`	Http methods to retry against. Default: `'GET', 'PUT'`
proxyConfiguration	`ProxyConfigurationBuilder`	Represents the proxy configurations for API calls
customHeaderAuthenticationCredentials	`CustomHeaderAuthenticationCredentials`	The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

$client = SwaggerPetstoreOpenAPI30ClientBuilder::init()
    ->customHeaderAuthenticationCredentials(
        CustomHeaderAuthenticationCredentialsBuilder::init(
            'api_key'
        )
    )
    ->build();

pet-store / petstore-sdk

Maintainers

Details

README

Introduction

Install the Package

Test the SDK

Initialize the API Client

Authorization

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities