README

About

Documentation will be a bit lackluster, and the unit tests need a lot of work. With that being said, I created this library more for use in my own projects that center around an API service; to decouple a lot of the logic that would be repeated in each API service library, to its own library.

It has a long way to go, but it should be relatively stable.

Features

Builds around guzzle/guzzle as the HTTP Client.
Cache's requests via Kevinrob/guzzle-cache-middleware.
Can retry requets on a connection or server error via the Guzzle Retry Middleware.
- Client::enableRetryAttempts() to instruct the client to attempt retries.
- Client::disableRetryAttempts() to disable attempt retries.
- Client::setMaxRetryAttempts() to set the maximum number of retries.
Can pass along headers in Client::build() to be 'persistent' headers, i.e. headers sent with every request.
One function that handles sending a request: Client::send()

It currently does not support async requests and pooling. Just your regular, good 'ol, standard requests.

Example

use Esi\Api\Client;

// api url, api key, cache path, does the api require key sent as a query arg, the name of the query arg
$client = new Client('https://myapiurl.com/api', 'myApiKey', '/var/tmp', true, 'api_key');

// Must first 'build' the client with (optional) $options array which can include any valid Guzzle option.
$client->build([
    'persistentHeaders' => [
        'Accept' => 'application/json',
    ],
    'allow_redirects' => true,
    // ... etc.
]);
$client->enableRetryAttempts();
$client->setMaxRetryAttempts(5);

$response = $client->send('GET', '/', ['query' => ['foo' => 'bar']]);

// Decode the json and return as array
$data = $client->toArray($response);

// or... as an object
$data = $client->toObject($response);

// or... for the raw json response, to do with as you will
$data = $client->raw(); // or $response->getBody()->getContents()

Requirements

PHP 8.2.0 or above.

Submitting bugs and feature requests

Bugs and feature requests are tracked on GitHub

Issues are the quickest way to report a bug. If you find a bug or documentation error, please check the following first:

That there is not an Issue already open concerning the bug
That the issue has not already been addressed (within closed Issues, for example)

Contributing

See CONTRIBUTING.

Author

Eric Sizemore - admin@secondversion.com - https://www.secondversion.com

License

Esi\Api is licensed under the MIT License - see the LICENSE.md file for details

esi / api

Maintainers

Details