esi/api is a simple wrapper/builder using Guzzle for base API clients.

You can install the package via composer:

$ composer require ericsizemore/api

• 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.

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()

• PHP 8.2.0 or above.

• Eric Sizemore
• All Contributors

See CONTRIBUTING.

Bugs and feature requests are tracked on GitHub.

See CODE_OF_CONDUCT.md

See backward-compatibility.md for more information on Backwards Compatibility.

See the CHANGELOG for more information on what has changed recently.

See the LICENSE for more information on the license that applies to this project.

See SECURITY for more information on the security disclosure process.