sdksio / swagger-petstore-3-sdk
This is a sample Pet Store Server based on the OpenAPI 3.0 specification.
Requires
- php: ^7.2 || ^8.0
- ext-json: *
- apimatic/core: ~0.3.0
- apimatic/core-interfaces: ~0.1.0
- apimatic/unirest-php: ^4.0.0
Requires (Dev)
- phan/phan: 5.4.2
- phpunit/phpunit: ^7.5 || ^8.5 || ^9.5
- squizlabs/php_codesniffer: ^3.5
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 "sdksio/swagger-petstore-3-sdk:1.0.0"
Or add it to the composer.json file manually as given below:
"require": { "sdksio/swagger-petstore-3-sdk": "1.0.0" }
You can also view the package at: https://packagist.org/packages/sdksio/swagger-petstore-3-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 usingphpunit --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:
The API client can be initialized as follows:
$client = SwaggerPetstoreOpenAPI30ClientBuilder::init() ->apiKey('api_key') ->build();
Authorization
This API uses Custom Header Signature
.