This package helps returning JSON API compliant errors while using the native Laravel validation logic. Also, it lets you add unique codes to your validation rules which makes it easier on the consumer end.
Laravel / Lumen | This Package |
---|---|
^10.0 |
^5.0 |
^9.0 |
^4.0 |
^8.0 |
^3.0 |
^7.0 |
^2.0 |
^6.0 |
^1.0 |
You can install the package via composer:
- Laravel / Lumen 10
composer require "nestecha/laravel-json-api-validation":"^5.0"
- Laravel / Lumen 9
composer require "nestecha/laravel-json-api-validation":"^4.0"
- Laravel / Lumen 8
composer require "nestecha/laravel-json-api-validation":"^3.0"
- Laravel / Lumen 7
composer require "nestecha/laravel-json-api-validation":"^2.0"
- Laravel / Lumen 6
composer require "nestecha/laravel-json-api-validation":"^1.0"
Go in App\Exceptions\Handler.php
and change the render
method :
/**
* Render an exception into an HTTP response.
*
* @param \Illuminate\Http\Request $request
* @param \Exception $exception
* @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
*/
public function render($request, Exception $exception)
{
if ($exception instanceof \Nestecha\LaravelJsonApiValidation\Exception\JsonApiValidationException) {
$responseFactory = new \Nestecha\LaravelJsonApiValidation\ResponseFactory();
return $responseFactory->fromErrors($exception->errors()->getArrayCopy());
}
return parent::render($request, $exception);
}
Then, in your controller :
public function home(Request $request)
{
$validator = new \Nestecha\LaravelJsonApiValidation\JsonApiValidator();
$validator->validateAsJsonApi($request->all(), ['title' => 'required']);
// ...
}
This would yield :
{
"errors": [
{
"status": "422",
"title": "Unprocessable Entity",
"detail": "The title field is required.",
"source": {
"pointer": "\/data\/attributes\/title",
"value": ""
},
"meta": {
"failed": {
"rule": "required"
}
}
}
]
}
To add a code to the errors, use this artisan command to copy the default config file to your config folder.
php artisan vendor:publish --tag=config
To add a code to the errors, a base config file is available, simply copy paste it into your config folder as json-api-validation.php
.
Then in bootstrap/app.php
add this line :
$app->configure('json-api-validation');
json-api-validation.php
is the default config filename. You can customize the validator by passing a string in the constructor :
public function home(Request $request)
{
$validator = new JsonApiValidator('name-of-your-config-file');
$validator->validateAsJsonApi($request->all(), ['title' => 'required']);
}
When using Laravel custom rules :
class UppercaseRule implements Rule
{
/**
* @inheritDoc
*/
public function passes($attribute, $value)
{
return strtoupper($value) === $value;
}
/**
* @inheritDoc
*/
public function message()
{
return "The :attribute should be uppercase.";
}
}
To add an error code in the config, you should use the name in kebab-case format :
return [
'uppercase-rule' => ['code' => 'VALIDATION_ERROR_UPPERCASE'],
];
The error will format the rule name in kebab-case in the meta field :
{
"errors": [
{
"status": "422",
"title": "Unprocessable Entity",
"detail": "The title should be uppercase.",
"source": {
"pointer": "\/data\/attributes\/title",
"value": "lowercase_title"
},
"meta": {
"failed": {
"rule": "uppercase-rule"
}
}
}
]
}
composer test
Please see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.