tr / test-sdk
r
9.5.6
2025-05-23 04:57 UTC
Requires
- php: ^7.2 || ^8.0
- ext-curl: *
- ext-json: *
- apimatic/core: ~0.3.13
- apimatic/core-interfaces: ~0.1.5
- apimatic/unirest-php: ^4.0.6
Requires (Dev)
- phan/phan: 5.4.5
- squizlabs/php_codesniffer: ^3.5
README
Introduction
This is a sample API to demonstrate an OpenAPI spec with multiple endpoints and a custom model.
Install the Package
Run the following command to install the package and automatically add the dependency to your composer.json file:
composer require "tr/test-sdk:2.1.8"
Or add it to the composer.json file manually as given below:
"require": { "tr/test-sdk": "2.1.8" }
You can also view the package at: https://packagist.org/packages/tr/test-sdk#2.1.8
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:
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: 413, 503, 504 |
httpMethodsToRetry | array |
Http methods to retry against. Default: 'GET', 'PUT', 'POST' |
loggingConfiguration | LoggingConfigurationBuilder |
Represents the logging configurations for API calls |
proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
The API client can be initialized as follows:
$client = CypressTestAPIClientBuilder::init() ->loggingConfiguration( LoggingConfigurationBuilder::init() ->level(LogLevel::INFO) ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) ) ->build();
List of APIs
SDK Infrastructure
Configuration
- ProxyConfigurationBuilder
- LoggingConfigurationBuilder
- RequestLoggingConfigurationBuilder
- ResponseLoggingConfigurationBuilder