pixelindustries/laravel-jsonapi

Laravel JSON-API Base.

This package is abandoned!, _(*1)

Please use czim/laravel-jsonapi instead., _(*2)

JSON-API Base

, _(*3)

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

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

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

Version Compatibility

Installation

Via Composer, _(*7)

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

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

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

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

``` bash php artisan vendor:publish, <sub>(*10)</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>(*11)</sub>

Middleware

To enforce correct headers, add the Pixelindustries\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>(*12)</sub>

<?php
    protected $middlewareGroups = [
        'api' => [
            // ... 
            \Pixelindustries\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>(*13)</sub>

Documentation

Request Data

Request Query String Data

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

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

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

Using the jsonapi_query() global helper function. This returns the singleton instance of Pixelindustries\JsonApi\Support\Request\RequestParser., <sub>(*16)</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>(*17)</sub>

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

    // Or by instantiating it manually ...
    $jsonapi = new \Pixelindustries\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, a special FormRequest is provided to validate and access request body data (\Pixelindustries\JsonApi\Http\Requests\JsonApiRequest)., <sub>(*18)</sub>

This class may be extended and used as any FormRequest class in Laravel., <sub>(*19)</sub>

There is also a global help function jsonapi_request(), that returns an instance of this class (and thus mimics Laravel's request())., <sub>(*20)</sub>

<?php
    // Get validated data for the current request
    $jsonApiType = jsonapi_request()->getType();
    $jsonApiId   = jsonapi_request()->getId();

Encoding

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

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

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

More information on encoding and configuring resources., <sub>(*24)</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>(*25)</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>(*26)</sub>

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

Contributing

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

Credits

• Pixelindustries
• Coen Zimmerman
• All Contributors

License

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