JSON Schema Request
Laravels Form Request Validation for JSON Schema documents
Installation
composer require wt-health/laravel-json-schema-request
Usage
The development experience is identical to Laravel's Form Request Validation, except instead of writing Laravel validation rules, you write a JSON Schema.
You can create a new request using the make:json-request command
artisan make:json-request MyJsonRequest
You will now have new request class App\Http\Requests\MyJsonRequest, Below you can see a basic example schema.
<?php
namespace App\Http\Requests;
use Wthealth\JsonSchemaRequest\JsonSchemaRequest;
class MyJsonRequest extends JsonSchemaRequest
{
public function schema(): array
{
return [
'type' => 'object',
'properties' => [
'first_name' => ['type' => 'string'],
'last_name' => ['type' => 'string'],
'email' => ['type' => 'string', 'format' => 'email'],
],
'required' => ['first_name', 'last_name', 'email'],
'additionalProperties' => false,
];
}
}
Once you have a JsonSchemaRequest object, all you need to do is type-hint the request on your controller method. The incoming form request is validated before the controller method is called.
public function store(MyJsonRequest $request)
{
// The incoming request is valid...
// Retrieve the validated input data...
$validated = $request->validated();
}
License
The MIT License (MIT). Please see License File for more information.
237 Nov 28, 2022
5 Jul 12, 2021
2 Dec 22, 2021
753 Dec 28, 2022
1 Jan 19, 2022
2 Jan 18, 2022
399 Dec 23, 2022
1 Nov 5, 2021
10.7k Jun 13, 2022
774 Dec 31, 2022
2 Jul 31, 2022
1 Dec 14, 2021
30 Oct 18, 2022
2 Nov 9, 2022
3.4k Dec 26, 2022
356 Dec 21, 2022
370 Dec 29, 2022
268 Sep 14, 2022
356 Dec 21, 2022
421 Jan 3, 2023
29 Nov 18, 2022
100 Oct 16, 2022
2 Nov 4, 2022
106 Dec 9, 2022
14 Nov 18, 2021
0 Oct 29, 2021
1 Dec 12, 2022
88 Nov 5, 2022