README

Create a json schema for your Laravel rules

Prerequisites

It is recommended to use FormRequest classes in your application to use this package. This allows for easy extraction of rule objects to pass them into this package.

You can still use this package just by passing in an array of rules, but that is a but more cumbersome.

Installation

You can install the package via composer:

composer require riley19280/laravel-rules-to-schema

And publish the config file with:

php artisan vendor:publish --tag="laravel-rules-to-schema-config"

Usage

use \Illuminate\Foundation\Http\FormRequest;

$schema = LaravelRulesToSchema::parse(FormRequest|array $rules): FluentSchema

$schema->compile(); // Returns an array representation of the json schema

Customization

JSON Schema Representation

This package relies on riley19280/fluent-json-schema to build and represent JSON schemas. For details on how to use and configure the objects returned from the rule parser, please see the documentation for that package.

Registering schemas for custom rules

JSON Schema definitions for custom rules can be registered in the config file by providing the rule name or class name.

The type can be any of the simple JSON schema types (array, boolean, integer, null, number, object, string). If a more complex type is required, you can provide the class name that implements LaravelRulesToSchema\Contracts\HasJsonSchema

// config/rules-to-schema.php

'custom_rule_schemas' => [
    // \CustomPackage\CustomRule::class => \Support\CustomRuleSchemaDefinition::class,
    // \CustomPackage\CustomRule::class => 'string',
    // \CustomPackage\CustomRule::class => ['null', 'string'],
],

Extending the rule parser

Should you want to further customize or tweak how rules are parsed, additional parsers can be added in the config file. Each parser is run for each rule in the order it is defined in the config file. Custom parsers must implement the LaravelRulesToSchema\Contracts\RuleParser interface.

// config/rules-to-schema.php

'parsers' => [
    ...
    \CustomPackage\CustomParser::class,
],

Tools for package developers

If your package contains a custom rule, you can provide the types as part of the package as well.

In a service provider you can use the following methods to programmatically register a rule or parser:

LaravelRulesToSchema::registerCustomRuleSchema(CustomRule::class, CustomRuleSchemaDefinition::class);
LaravelRulesToSchema::registerParser(CustomParser::class);

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

riley19280 / laravel-rules-to-schema

Maintainers

Details