elife / api-sdk
eLife Sciences API SDK
Installs: 23 772
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 11
Forks: 3
Open Issues: 4
Requires
- php: ^7.1 || ^8.0
- composer/package-versions-deprecated: 1.11.99.2
- elife/api-client: ^1.0
- guzzlehttp/promises: ^1.0
- guzzlehttp/psr7: ^1.0
- symfony/serializer: ^2.8.2 || ^3.0.2
Requires (Dev)
- csa/guzzle-cache-middleware: ^1.0
- elife/api: 2.30.0
- elife/api-validator: ^1.0
- guzzlehttp/guzzle: ^6.0
- justinrainbow/json-schema: ^3.0 || ^4.0 || ^5.0
- mindplay/composer-locator: ^2.1.1
- mtdowling/jmespath.php: ^2.0
- phpspec/phpspec: ^5.1 || ^6.3 || ^7.5
- phpspec/prophecy: ^1.10
- phpunit/phpunit: ^7.5 || ^9.6
- psr/http-message: ^1.0
- squizlabs/php_codesniffer: ^3.5
Conflicts
- sebastian/comparator: <1.2.3
This package is auto-updated.
Last update: 2024-11-15 08:39:49 UTC
README
This library provides a PHP SDK for the eLife Sciences API.
It includes code from the CsaGuzzleBundle for testing, which in the future will be a normal dependency (see csarrazi/CsaGuzzleBundle#169).
Dependencies
- Composer
- PHP 7
Installation
Execute composer require elife/api-sdk.
Usage (ApiClient)
The eLife\ApiSdk\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\ApiSdk\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'));