PHPackages                             pet-store/petstore-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. pet-store/petstore-sdk

ActiveLibrary[API Development](/categories/api)

pet-store/petstore-sdk
======================

Use the PetStore Api to get details about Pets and Stores

1.0.0(1y ago)00MITPHPPHP ^7.2 || ^8.0

Since May 5Pushed 1y ago1 watchersCompare

[ Source](https://github.com/WasifMatic/yd0opj6euy)[ Packagist](https://packagist.org/packages/pet-store/petstore-sdk)[ Docs](https://www.apimatic.io)[ RSS](/packages/pet-store-petstore-sdk/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (6)Versions (2)Used By (0)

Getting Started with Swagger Petstore - OpenAPI 3.0
===================================================

[](#getting-started-with-swagger-petstore---openapi-30)

Introduction
------------

[](#introduction)

This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at . 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](https://editor.swagger.io/?url=https://petstore.swagger.io/v2/swagger.yaml). Alternatively, you can load via the `Edit > Load Petstore OAS 2.0` menu option!*

Some useful links:

- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)
- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)

Find out more about Swagger:

Install the Package
-------------------

[](#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:

Test the SDK
------------

[](#test-the-sdk)

Unit tests in this SDK can be run using PHPUnit.

1. First install the dependencies using composer including the `require-dev` dependencies.
2. 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
-------------------------

[](#initialize-the-api-client)

***Note:*** Documentation for the client can be found [here.](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/client.md)

The following parameters are configurable for the API Client:

ParameterTypeDescriptiontimeout`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`](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/proxy-configuration-builder.md)Represents the proxy configurations for API callscustomHeaderAuthenticationCredentials[`CustomHeaderAuthenticationCredentials`](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/auth/custom-header-signature.md)The Credentials Setter for Custom Header SignatureThe API client can be initialized as follows:

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

Authorization
-------------

[](#authorization)

This API uses the following authentication schemes.

- [`api_key (Custom Header Signature)`](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/auth/custom-header-signature.md)

List of APIs
------------

[](#list-of-apis)

- [Pet](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/controllers/pet.md)
- [Store](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/controllers/store.md)
- [User](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/controllers/user.md)

SDK Infrastructure
------------------

[](#sdk-infrastructure)

### Configuration

[](#configuration)

- [ProxyConfigurationBuilder](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/proxy-configuration-builder.md)

### HTTP

[](#http)

- [HttpRequest](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/http-request.md)
- [HttpResponse](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/http-response.md)

### Utilities

[](#utilities)

- [FileWrapper](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/file-wrapper.md)
- [ApiException](https://www.github.com/WasifMatic/yd0opj6euy/tree/1.0.0/doc/api-exception.md)

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance49

Moderate activity, may be stable

Popularity0

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

373d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/055c3baef3b8b1167e8715f0367f954b64caec3f25bddb923c1d9fc7c2068bc3?d=identicon)[WasifMatic](/maintainers/WasifMatic)

---

Top Contributors

[![WasifMatic](https://avatars.githubusercontent.com/u/209454907?v=4)](https://github.com/WasifMatic "WasifMatic (1 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/pet-store-petstore-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/pet-store-petstore-sdk/health.svg)](https://phpackages.com/packages/pet-store-petstore-sdk)
```

###  Alternatives

[square/square

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.

793.4M21](/packages/square-square)[paypal/paypal-server-sdk

PayPal's SDK for interacting with the REST APIs

53456.5k3](/packages/paypal-paypal-server-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)