elife / api-client
eLife Sciences API client
Installs: 22 403
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 13
Forks: 1
Open Issues: 4
Requires
- php: ^7.1
- beberlei/assert: >=2.2
- composer/package-versions-deprecated: 1.11.99.2
- crell/api-problem: ^3.6
- guzzlehttp/promises: ^1.0
- guzzlehttp/psr7: ^1.0
- psr/http-message: ^1.0
Requires (Dev)
- guzzlehttp/guzzle: ^6.0
- mtdowling/jmespath.php: ^2.0
- phpspec/phpspec: ^5.1 || ^6.3 || ^7.5
- phpspec/prophecy: ^1.10
- phpunit/phpunit: ^7.5.20 || ^8.5 || ^9.6 || ^10.2
- psr/log: ^1.0
- squizlabs/php_codesniffer: ^3.10
Suggests
- guzzlehttp/guzzle: ^6.0, to use the Guzzle6HttpClient adapter
- monolog/monolog: ^1.0, to use the HttpMessageProcessor log processor
- mtdowling/jmespath.php: ^2.0, to use the Result::search() method
- psr/log: ^1.0, to use the WarningCheckingHttpClient adapter
This package is auto-updated.
Last update: 2024-09-29 08:03:11 UTC
README
This library provides a PHP client for the eLife Sciences API.
Dependencies
- PHP 7
You will need an implementation of eLife\ApiClient\HttpClient
; the client provides an adapter for Guzzle 6.
Installation
Execute composer require elife/api-client
.
Usage
The eLife\ApiClient\ApiClient
namespace provides separate clients for each part of the eLife API.
Each method on an API client represents an endpoint.
You can pass default headers to an API client, and/or to each API client method. You should provide an Accept
header stating which versions you support.
API clients always return instances of GuzzleHttp\Promise\PromiseInterface
, which wrap instances of eLife\ApiClient\Result
, which in turn wrap the JSON response.
eLife\ApiClient\Result
provides integration with the JMESPath (using jmespath.php), to allow easy searching of JSON responses.
Basic example
To list the Labs Post IDs that appear on the first page of the endpoint:
use eLife\ApiClient\ApiClient\LabsClient; use eLife\ApiClient\HttpClient\Guzzle6HttpClient; use eLife\ApiClient\MediaType; use GuzzleHttp\Client as Guzzle; $guzzle = new Guzzle(['base_uri' => 'https://api.elifesciences.org/']); $httpClient = new Guzzle6HttpClient($guzzle); $labsClient = new LabsClient($httpClient); var_dump($labsClient->listPosts(['Accept' => new MediaType(LabsClient::TYPE_POST_LIST, 1)])->wait()->search('items[*].id'));
Deprecation warnings
As the eLife API provides deprecation warnings using the HTTP Warning
header, the eLife\ApiClient\HttpClient\WarningCheckingHttpClient
will pass these to a PSR-7 logger.