README

Client for easy access of data from {json:api} API. Making requests to API by using PHP HTTP Clients like Guzzle or CURL requires to much code. This package tries to simplify this process, by allowing to get data from API as simply as:

$response = JsonApiClient::get('users');
//Let's return this data to view
return view('users', ['users'=> $response->data]);

Installation

Install package composer require dorvidas\laravel-json-api-client.
Add service provider Dorvidas\JsonApiClient\Providers\JsonApiClientServiceProvider::class to config/app.php
Publish vendor config php artisan vendor:publish.

Usage

Getting the client

You can get client in several ways:

Via Facade \Dorvidas\JsonApiClient\Facades\JsonAPIClient
Resolving from service container Dorvidas\JsonApiClient\JsonApiClient::class

Making requests

get($endpoint)

JsonApiClient::get('users'); //get users

post($endpoint)

JsonApiClient::jsonData([])->post('users');//store user

patch($endpoint)

JsonApiClient::jsonData([])->patch('users');//do patch request

Request options

JsonApiClient::get('users')->withIncludes(['posts']) - adds query param include=posts to request URL. See http://jsonapi.org/format/#fetching-includes
JsonApiClient::get('users')->withFields(['user'=> ['id','name']]) - adds query param fields[users]=id,name. See http://jsonapi.org/format/#fetching-sparse-fieldsets
JsonApiClient::get('users')->withFilters(['users'=>['id'=>['eq'=>1]]]) - adds query param filter[users][id][eq]=1. {json:api} is agnostic about filtering, so you can choose your filtering strategy and pass what ever array you want. See http://jsonapi.org/format/#fetching-filtering.
JsonApiClient::get('users')->withQuery(['field'=>1]) - adds query param field=1=1. In theory adding filter, includes, fields and pagination fields should be sufficient.
JsonApiClient::limit($limit, $offset)->get('users') - add result constraints to query param `page[limit]=x&page[offet]=y. See http://jsonapi.org/format/#fetching-pagination
JsonApiClient::formData(['name'=>'John'])->post('users') - define post form data. Form data can contain files i.e JsonApiClient::formData(['image'=> $request->file('image')])->post('photos').
JsonApiClient::jsonData(['name'=>'John'])->post('users') - define post JSON data.
JsonApiClient::throwException(true) - whenever non 2xx status code received and appropriate exception is thrown. Set to false if you want handel request response status yourself.
JsonApiClient::token($accessToken)->get('users') - define access token which will be added to Authorization:Bearer {$accessToken} header. Note, if there is jwt session variable there is no need to set token here, because access token will be added to request automatically.

Handling response

Requests will return JsonApiResponse object. It will contain public variables:

$resopnse->data - contains response data.
$resopnse->meta - contains meta data of a response.
$resopnse->errors - contains errors data of a response.
$resopnse->status - holds HTTP status code of request. Also it has helper functions
$resopnse->meta('count') - return meta data with key count.

Exceptions

//@todo

dorvidas / laravel-json-api-client

Maintainers

Details