json-api-server/docs/laravel.md

Laravel Helpers

These helpers improve the ergonomics of your API resource definitions when using the Laravel framework.

Validation

rules

Use Laravel's Validation component as a field validator.

use Tobyz\JsonApiServer\Laravel;

$type->attribute('name')
    ->validate(Laravel\rules(['required', 'min:3', 'max:20']));

Pass a string or array of validation rules to be applied to the value. Validating array contents is also supported:

$type->attribute('jobs')
    ->validate(Laravel\rules([
        'required', 'array',
        '*' => ['string', 'min:3', 'max:255']
    ]));

You can also pass an array of custom messages and custom attribute names as the second and third arguments.

Authentication

authenticated

A shortcut to call Auth::check().

$type->creatable(Laravel\authenticated());

can

Use Laravel's Gate component to check if the given ability is allowed. If this is used in the context of a model (eg. updatable, deletable, or on a field), then the model will be passed to the gate check as well.

$type->updatable(Laravel\can('update-post'));