JSON Schema Validator for Laravel

JSON Schema Validator for Laravel it is a Composer package created to validate JSON objects against JSON Schemas as an Illuminate\Validation\Validator custom rule.

About

This package works only at Laravel versions >= 5.8. And PHP version >= 7.3.

We uses the incredible package swaggest/json-schema as a dependency to make everything works like magic.

Installation

Add the following line to the require section of composer.json:

{
    "require": {
        "henriqueramos/laravel_json_schema_validator": "^1.0.0"
    }
}

Setup

1. Run php artisan vendor:publish --provider="RamosHenrique\JsonSchemaValidator". This will create on your config folder a file named json_schema_validator.php.
2. In your .env file, add your JSON Schema files storage path with key JSON_SCHEMA_VALIDATOR_STORAGE_PATH (i.e JSON_SCHEMA_VALIDATOR_STORAGE_PATH=storage/jsonschemas/).
3. Set up your JSON Schema file

What is a JSON Schema

We supported the following schemas:

• JSON Schema Draft 7
• JSON Schema Draft 6
• JSON Schema Draft 4

Here's an example for JSON Schema and a valid payload for him:

$schemaJson = <<<'JSON'
{
    "type": "object",
    "properties": {
        "uuid": {
            "type": "integer"
        },
        "userId": {
            "type": "integer"
        },
        "items": {
            "type": "array",
            "minimum": 1,
            "items": {
                "$ref": "#/definitions/items"
            }
        }
    },
    "required":[
	    "uuid",
	    "userId",
	    "items",
	],
    "definitions": {
        "items": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "integer"
                },
                "price": {
                    "type": "number"
                },
                "updated": {
                    "type": "string",
                    "format": "date-time"
                }
            },
            "required":[
	            "id",
	            "price"
	        ]
        }
    }
}
JSON;

$payload = <<<'JSON'
{
  "uuid": 8,
  "userId": 1,
  "items": [
	{
    	"id": 12,
        "price": 49.90,
        "updated": "2020-09-07T20:20:39-03:00"
	},
    {
      	"id": 15,
      	"price": 99,
      	"updated": "2020-06-22T16:48:12-03:00"
    }
  ]
}
JSON;

Usage

After save the JSON Schema file on your chosen storage path, you can use this as a Validation Rule on your FormRequest extended class.

<?php declare(strict_types = 1);

namespace RamosHenrique\Requests;

use Illuminate\Foundation\Http\FormRequest;

class ValidatingPayloadRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize(): bool
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules(): array
    {
        return [
            'jsonData' => [
                'bail',
                'required',
                'json',
                'json_schema_validator:validJSONSchema.json',
            ],
        ];
    }

    /**
     * Custom messages for the route validator.
     *
     * @return array
     */
    public function messages(): array
    {
        return [
            'expectedData.required' => 'required.jsonData',
            'expectedData.json' => 'expectedData.needs.needs.to.be.a.valid.json',
        ];
    }
}