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 "gallagher-suarez-traders/wesley-key-sdk:1.1.3"

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

"require": {
    "gallagher-suarez-traders/wesley-key-sdk": "1.1.3"
}

You can also view the package at: https://packagist.org/packages/gallagher-suarez-traders/wesley-key-sdk#1.1.3

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 CypressTestAPILib\Environment;
use CypressTestAPILib\CypressTestAPIClientBuilder;

$client = CypressTestAPIClientBuilder::init()
    ->environment(Environment::PRODUCTION)
    ->defaultHost('www.example.com')
    ->build();

List of APIs

• API

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• ApiException