drpdigital/laravel-json-api-parser

Laravel integration for the jsonapi.org parser

JSON API parser for Laravel

, _(*1)

This is a Laravel framework integration for the JSON API parser., _(*2)

The JSON API parser allows you to read and validate requests that are structured with the jsonapi.org specification., _(*3)

Version compatibility

Installation

You install the package by using composer:, _(*4)

composer require drpdigital/laravel-json-api-parser

If you are using Laravel 5.5 onwards the package will automatically register itself., _(*5)

If you are on Laravel 5.4 or lower then you will need to register the service provider in your config/app.php, _(*6)

'providers' => [
    ...
    \Drp\LaravelJsonApiParser\JsonApiParserServiceProvider::class,
    ...
]

Documentation

How to validate your resources

When wanting to validate a resource within your payload, you need to give the JsonApiValidator a ValidatorExecutor. This can be done in a few ways specified below. With all of these the first parameter is a string of the type of resource it needs to validate., _(*7)

So for example if you had a request like:, _(*8)

{
  "data": {
    "id": 1,
    "type": "user",
    "attributes": {
      "name": "Bob"
    }
  }
}

Then your first parameter would be 'user'., _(*9)

Using ::make

$jsonApiValidator = app(JsonApiValidator::class);
$jsonApiValidator->validator(
    'user',
    \Drp\LaravelJsonApiParser\Validation\Validator::make(
        ['name' => 'required'],
        ['name.required' => 'You must provide a name']
    )
);

The rules and messages you provide are whatever Laravel can support as our validator is just a decorated for Laravel's., _(*10)

Using custom class

When using a custom validator class you will need to extend our validator class \Drp\LaravelJsonApiParser\Validation\Validator. You then specify a rules and messages function inside the class and return an array of rules and messages in their respective functions., _(*11)

<?php

namespace App\Validators;

use Drp\LaravelJsonApiParser\Validation\Validator;

class UserValidator extends Validator
{
    public function rules()
    {
        return [
            'name' => 'required',
        ];
    }

    public function messages()
    {
        return [
           'name.required' => 'Testing Message',
        ];
    }
}

$jsonApiValidator = app(JsonApiValidator::class);
$jsonApiValidator->validator(
    'user',
    new UserValidator()
);

How to resolve your resources into Models

For more documentation on how to use the JSON API parser please visit the base package's repository., _(*12)

Sample Usage

The request:, _(*13)

{
  "data": {
    "type": "brochure",
    "attributes": {
      "title": "My Brochure",
      "page_size": "A4"
    }
  }
}

The handler:, _(*14)

public function store(Request $request) : array
{
    $collection = json_api()
        ->resolver('brochure', function (array $data) {
            return Brochure::create($data);
        })->parse($request->json()->all());
}

Contributing

Raise any issues or feature requests within GitHub and please follow our guidelines when contributing., _(*15)

If you have found a security vulnerability with the package please email Chris directly at chris.normansell@drpgroup.com, _(*16)

License

The Laravel JSON API Parser integration and it's base package are both realted under the [MIT License]., _(*17)