vender-demo / first-project
First Profile demo
Requires
- php: ^7.2 || ^8.0
- ext-curl: *
- ext-json: *
- apimatic/core: ~0.3.17
- apimatic/core-interfaces: ~0.1.5
- apimatic/unirest-php: ^4.0.6
Requires (Dev)
- phan/phan: 5.4.5
- squizlabs/php_codesniffer: ^3.5
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is not auto-updated.
Last update: 2026-10-27 09:26:20 UTC
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.
Some useful links:
Find out more about Swagger: https://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 "vender-demo/first-project:1.5.0"
Or add it to the composer.json file manually as given below:
"require": { "vender-demo/first-project": "1.5.0" }
You can also view the package at: https://packagist.org/packages/vender-demo/first-project#1.5.0
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 |
|---|---|---|
| environment | Environment |
The API environment. Default: Environment.PRODUCTION |
| timeout | int |
Timeout for API calls in seconds. Default: 30 |
| 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, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524 |
| httpMethodsToRetry | array |
Http methods to retry against. Default: 'GET', 'PUT', 'GET', 'PUT' |
| loggingConfiguration | LoggingConfigurationBuilder |
Represents the logging configurations for API calls |
| proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
| petstoreAuthCredentials | PetstoreAuthCredentials |
The Credentials Setter for OAuth 2 Implicit Grant |
| apiKeyCredentials | ApiKeyCredentials |
The Credentials Setter for Custom Header Signature |
The API client can be initialized as follows:
use SwaggerPetstoreOpenApi30Lib\Logging\LoggingConfigurationBuilder; use SwaggerPetstoreOpenApi30Lib\Logging\RequestLoggingConfigurationBuilder; use SwaggerPetstoreOpenApi30Lib\Logging\ResponseLoggingConfigurationBuilder; use Psr\Log\LogLevel; use SwaggerPetstoreOpenApi30Lib\Environment; use SwaggerPetstoreOpenApi30Lib\Authentication\PetstoreAuthCredentialsBuilder; use SwaggerPetstoreOpenApi30Lib\Models\OauthScopePetstoreAuth; use SwaggerPetstoreOpenApi30Lib\Authentication\ApiKeyCredentialsBuilder; use SwaggerPetstoreOpenApi30Lib\SwaggerPetstoreOpenApi30ClientBuilder; $client = SwaggerPetstoreOpenApi30ClientBuilder::init() ->petstoreAuthCredentials( PetstoreAuthCredentialsBuilder::init( 'OAuthClientId', 'OAuthRedirectUri' ) ->oauthScopes( [ OauthScopePetstoreAuth::WRITEPETS, OauthScopePetstoreAuth::READPETS ] ) ) ->apiKeyCredentials( ApiKeyCredentialsBuilder::init( 'api_key' ) ) ->environment(Environment::PRODUCTION) ->loggingConfiguration( LoggingConfigurationBuilder::init() ->level(LogLevel::INFO) ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) ) ->build();
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | Default |
Authorization
This API uses the following authentication schemes.
List of APIs
SDK Infrastructure
Configuration
- ProxyConfigurationBuilder
- LoggingConfigurationBuilder
- RequestLoggingConfigurationBuilder
- ResponseLoggingConfigurationBuilder