czim/laravel-jsonapi

Laravel JSON-API Base.

![Software License][ico-license] , _(*1)

JSON-API Base

Basic application elements for JSON-API projects., _(*2)

Offers means for quickly scaffolding JSON-API compliance for Laravel applications., _(*3)

This does NOT provide the means to set up the API or the means for user authorisation., _(*4)

Disclaimer

This is very much a work in progress at this time. Interface- and other breaking changes may happen.
The old, discontinued version of this project is in the 0.9.5 branch., _(*5)

Version Compatibility

Note that version 1.5+ requires PHP 7.1.3+ and czim/laravel-dataobject 2.0+., _(*6)

Changelog

View the changelog., _(*7)

Installation

Via Composer, _(*8)

``` bash $ composer require czim/laravel-jsonapi, <sub>(*9)</sub>

Add the `JsonApiServiceProvider` to your `config/app.php`:

``` php
Czim\JsonApi\Providers\JsonApiServiceProvider::class,

Publish the configuration file., <sub>(*10)</sub>

``` bash php artisan vendor:publish, <sub>(*11)</sub>

### Exceptions

In your `App\Exceptions\Handler`, change the `render()` method like so:

```php
<?php

    public function render($request, Exception $exception)
    {
        if (is_jsonapi_request() || $request->wantsJson()) {
            return jsonapi_error($exception);
        }

        // ...

This will render exceptions thrown for all JSON-API (and JSON) requests as JSON-API error responses., <sub>(*12)</sub>

Middleware

To enforce correct headers, add the Czim\JsonApi\Http|Middleware\JsonApiHeaders middleware to the middleware group or relevant routes. You can do this by adding it to your App\Http\Kernel class:, <sub>(*13)</sub>

<?php
    protected $middlewareGroups = [
        'api' => [
            // ... 
            \Czim\JsonApi\Http\Middleware\RequireJsonApiHeader::class,
        ],
    ];

Note that this will block access to any consumers of your API that do not conform their HTTP header use to the JSON-API standard., <sub>(*14)</sub>

Documentation

Request Data

Request Query String Data

JSON-API suggests passing in filter and page data using GET parameters, such as:, <sub>(*15)</sub>

{API URL}?filter[id]=13&page[number]=2

This package offers tools for accessing this information in a standardized way:, <sub>(*16)</sub>

Using the jsonapi_query() global helper function. This returns the singleton instance of Czim\JsonApi\Support\Request\RequestParser., <sub>(*17)</sub>

<?php
    // Get the full filter data associative array.
    $filter = jsonapi_query()->getFilter();

    // Get a specific filter key value, if it is present (with a default fallback).
    $id = jsonapi_query()->getFilterValue('id', 0);

    // Get the page number.
    $page = jsonapi_query()->getPageNumber();

You can ofcourse also instantiate the request parser yourself to access these methods:, <sub>(*18)</sub>

<?php
    // Using the interface binding ...
    $jsonapi = app(\Czim\JsonApi\Contracts\Support\Request\RequestQueryParserInterface::class);

    // Or by instantiating it manually ...
    $jsonapi = new \Czim\JsonApi\Support\Request\RequestQueryParser(request());

    // After this, the same methods are available
    $id = $jsonapi->getFilterValue('id');

Request Body Data

For PUT and POST requests with JSON-API formatted body content, special FormRequests are provided to validate and access request body data: \Czim\JsonApi\Http\Requests\JsonApiRequest., <sub>(*19)</sub>

For POST requests where id may be omitted while creating a resource, use \Czim\JsonApi\Http\Requests\JsonApiRequest instead., <sub>(*20)</sub>

These classes may be extended and used as any other FormRequest class in Laravel., <sub>(*21)</sub>

There are also a global help functions jsonapi_request() and jsonapi_request_create(), that returns an instance of the relevant request class (and so mimics Laravel's request())., <sub>(*22)</sub>

Using this approach guarantees that requests are valid JSON-API by validating the input against a JSON Schema., <sub>(*23)</sub>

<?php
    // Get the root type of the object (which may be 'resource', 'error' or 'meta').
    $rootType = jsonapi_request()->data()->getRootType();

    // Get validated data for the current request.
    // This returns an instance of \Czim\JsonApi\Data\Root, which is a data object tree.
    $root = jsonapi_request()->data();

    // You can check what kind of resource data is contained.
    if ( ! $root->hasSingleResourceData()) {
        // In this case, the request would either have no "data" key,
        // or it would contain NULL or an array of multiple resources.
    } elseif ($root->hasMultipleResourceData()) {
        // In this case, the request has a "data" key that contains an array of resources.
    }

    // Embedded data may be accessed as follows (for single resource).
    $resourceId     = $root->data->id;
    $resourceType   = $root->data->type; 
    $attributeValue = $root->data->attributes->name;
    $relationType   = $root->data->relationships['some-relationship']->data->type;

The request data tree for a single-resource request:, <sub>(*24)</sub>

, <sub>(*25)</sub>

For more information on the data object tree, see the Data classes., <sub>(*26)</sub>

Encoding

This package offers an encoder to generate valid JSON-API output for variable input content., <sub>(*27)</sub>

With some minor setup, it is possible to generate JSON output according to JSON-API specs for Eloquent models and errors., <sub>(*28)</sub>

Eloquent models, single, collected or paginated, will be serialized as JSON-API resources., <sub>(*29)</sub>

More information on encoding and configuring resources., <sub>(*30)</sub>

Custom Encoding & Transformation

To use your own transformers for specific class FQNs for the content to be encoded, map them in the jsonapi.transform.map configuration key:, <sub>(*31)</sub>

<?php
    'map' => [
        \Your\ContentClassFqn\Here::class => \Your\TransformerClassFqn\Here::class,        
    ],

This mapping will return the first-matched for content using is_a() checks. More specific matches should be higher in the list., <sub>(*32)</sub>

As a last resort, you can always extend and/or rebind the Czim\JsonApi\Encoder\Factories\TransformerFactory to provide your own transformers based on given content type., <sub>(*33)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*34)</sub>

Credits

• Coen Zimmerman
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*35)</sub>