Wallogit.com
2017 © Pedro Peláez
, (*1)
Make it a breeze to create a jsonapi.org RC3 compliant API with Laravel 5., (*2)
Code forked from echo-it/laravel-jsonapi project by Ronni Egeriis Persson., (*3)
Add felipe-douradinho/laravel-jsonapi to your composer.json dependency list, (*4)
Run composer update., (*5)
This library is made with the concept of exposing models in mind, as found in the RESTful API approach., (*6)
In few steps you can expose your models:, (*7)
Create a route to direct the requests, (*8)
In this example, we use a route for any OPTION requests, a generic route for interacting with resources, and another route for interacting with resource relationships:, (*9)
Route::options('api/{model}/{id?}', 'ApiController@handleRequest');
Route::any('api/{model}/{id?}', 'ApiController@handleRequest');
Route::any('api/{model}/{id}/links/{relation}', 'ApiController@handleRequest');
Create your controller to handle the request, (*10)
Your controller is responsible to handling input, instantiating a handler class and returning the response., (*11)
<?php namespace App\Http\Controllers;
use FelipeDouradinho\JsonApi\Request as ApiRequest;
use FelipeDouradinho\JsonApi\ErrorResponse as ApiErrorResponse;
use FelipeDouradinho\JsonApi\Exception as ApiException;
use Request;
class ApiController extends Controller
{
public function handleRequest($modelName, $id = null, $relation = null)
{
/**
* Create handler name from model name
* @var string
*/
$handlerClass = 'App\\Handlers\\' . ucfirst($modelName) . 'Handler';
if (class_exists($handlerClass)) {
$url = Request::url();
$method = Request::method();
$include = ($i = Request::input('include')) ? explode(',', $i) : [];
$sort = ($i = Request::input('sort')) ? explode(',', $i) : [];
$filter = ($i = Request::except('sort', 'include', 'page')) ? $i : [];
$content = Request::getContent();
$page = ($i = Request::input('page')) ? $i : [];
if (!empty($page) && (!is_array($page) || empty($page['size']) || empty($page['number']))) {
return new ApiErrorResponse(400, 400, 'Expected page[size] and page[number]');
}
$request = new ApiRequest(Request::url(), $method, $id, $content, $include, $sort, $filter, $page, $relation);
$handler = new $handlerClass($request);
// A handler can throw EchoIt\JsonApi\Exception which must be gracefully handled to give proper response
try {
$res = $handler->fulfillRequest();
} catch (ApiException $e) {
return $e->response();
}
return $res->toJsonResponse();
}
// If a handler class does not exist for requested model, it is not considered to be exposed in the API
return new ApiErrorResponse(404, 404, 'Entity not found');
}
}
Create a handler for your model, (*12)
A handler is responsible for exposing a single model., (*13)
In this example we have create a handler which supports the following requests:, (*14)
Requests are automatically routed to appropriate handle functions., (*15)
<?php namespace App\Handlers;
use Symfony\Component\HttpFoundation\Response;
use App\Models\User;
use FelipeDouradinho\JsonApi\Exception as ApiException;
use FelipeDouradinho\JsonApi\Request as ApiRequest;
use FelipeDouradinho\JsonApi\Handler as ApiHandler;
use Request;
/**
* Handles API requests for Users.
*/
class UsersHandler extends ApiHandler
{
const ERROR_SCOPE = 1024;
/**
* Handles GET requests.
* @param FelipeDouradinho\JsonApi\Request $request
* @return FelipeDouradinho\JsonApi\Model|Illuminate\Support\Collection|FelipeDouradinho\JsonApi\Response|Illuminate\Pagination\LengthAwarePaginator
*/
public function handleGet(ApiRequest $request)
{
//you can use the default GET functionality, or override with your own
return $this->handleGetDefault($request, new User);
}
/**
* Handles PATCH requests.
* @param FelipeDouradinho\JsonApi\Request $request
* @return FelipeDouradinho\JsonApi\Model|Illuminate\Support\Collection|FelipeDouradinho\JsonApi\Response
*/
public function handlePatch(ApiRequest $request)
{
//you can use the default PATCH functionality, or override with your own
return $this->handlePatchDefault($request, new User);
}
}
Note: Extend your models from FelipeDouradinho\JsonApi\Model rather than Eloquent to get the proper response for linked resources. In your model, you can define which relationships should be exposed:, (*16)
<?php namespace App\Models;
use FelipeDouradinho\JsonApi\Model as ApiModel;
class User extends ApiModel {
public $exposedRelations = ['friends'];
public function friends()
{
return $this->hasMany('App\Models\Friend');
}
}
According to jsonapi.org:, (*17)
The features in the Handler class are each in their own function (eg. handlePaginationRequest, handleSortRequest, etc.), so you can easily override them with your own behaviour if desired., (*18)
MIT