README

Introduction

This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key to test the authorization filters.

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 "zahra-mapping/rose-test-sdk:0.1.5"

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

"require": {
    "zahra-mapping/rose-test-sdk": "0.1.5"
}

You can also view the package at: https://packagist.org/packages/zahra-mapping/rose-test-sdk#0.1.5

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

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:

use SwaggerPetstoreLib\Environment;
use SwaggerPetstoreLib\Authentication\ApiKeyCredentialsBuilder;
use SwaggerPetstoreLib\Authentication\HttpBasicCredentialsBuilder;
use SwaggerPetstoreLib\Authentication\PetstoreAuthCredentialsBuilder;
use SwaggerPetstoreLib\Models\OAuthScopePetstoreAuthEnum;
use SwaggerPetstoreLib\SwaggerPetstoreClientBuilder;

$client = SwaggerPetstoreClientBuilder::init()
    ->apiKeyCredentials(
        ApiKeyCredentialsBuilder::init(
            'api_key'
        )
    )
    ->httpBasicCredentials(
        HttpBasicCredentialsBuilder::init(
            'username',
            'passwprd'
        )
    )
    ->petstoreAuthCredentials(
        PetstoreAuthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthRedirectUri'
        )
            ->oAuthScopes(
                [
                    OAuthScopePetstoreAuthEnum::READPETS,
                    OAuthScopePetstoreAuthEnum::WRITEPETS
                ]
            )
    )
    ->testHeader('TestHeaderDefaultValue')
    ->environment(Environment::PRODUCTION)
    ->build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• api_key (Custom Header Signature)
• httpBasic (Basic Authentication)
• petstore_auth (OAuth 2 Implicit Grant)

List of APIs

• Pet
• Store
• User

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• FileWrapper
• ApiException