Validation

The base ApiController class that your controller extends contains calls to Laravel’s Validation system.

THe api controller uses a custom FormRequest class to allow validation errors to be returned as part of the json response.

To create your own validator/form request class.

For the controller you can set the request class that is used e.g.

by setting

protected string $request = 'SomeRequest';

in the controller definition

The form request class needs to define 3 methods

commonRules

    public function commonRules() : array

returns an array of Laravel rules that will be run on both model store & update methods.

storeRules

public function storeRules() : array

returns an array of Laravel rules that will be run on just the model store method.

updateRules

public function updateRules() : array

returns an array of Laravel rules that will be run on just the model update method.

Examples

public function commonRules() : array
{
    return  [
        'age' => ['required'],
        'email' => ['required'],
    ];
}

public function updateRules() : array
{
    return [
        'email' => ['unique:users,email,' . $this->id]
    ];
}