ergebnis / json-schema-validator
Provides a JSON schema validator, building on top of justinrainbow/json-schema.
Installs: 12 507 606
Dependents: 5
Suggesters: 0
Security: 0
Stars: 30
Watchers: 3
Forks: 1
Open Issues: 1
Requires
- php: ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0
- ext-json: *
- ergebnis/json: ^1.2.0
- ergebnis/json-pointer: ^3.4.0
- justinrainbow/json-schema: ^5.2.12
Requires (Dev)
- ergebnis/data-provider: ^3.2.0
- ergebnis/license: ^2.4.0
- ergebnis/php-cs-fixer-config: ^6.36.0
- ergebnis/phpunit-slow-test-detector: ^2.15.1
- fakerphp/faker: ^1.23.1
- infection/infection: ~0.26.6
- phpunit/phpunit: ^9.6.20
- psalm/plugin-phpunit: ~0.19.0
- rector/rector: ^1.2.5
- vimeo/psalm: ^5.26.1
README
This project provides a composer
package with a JSON schema validator, building on top of justinrainbow/json-schema
.
Installation
Run
composer require ergebnis/json-schema-validator
Usage
If you have used the validator from justinrainbow/json-schema
before, you might have observed that it has a few flaws:
- The validator is stateful.
- The validator requires decoding JSON strings before validating them.
- The validator returns an
array
of errors, where each error is anarray
.
This package delegates the validation to justinrainbow/json-schema
and provides a friendlier interface.
<?php declare(strict_types=1); use Ergebnis\Json\Json; use Ergebnis\Json\Pointer; use Ergebnis\Json\SchemaValidator; $json = Json::fromFile('composer.json'); $schema = Json::fromString(file_get_contents('https://getcomposer.org/schema.json')); $jsonPointer = Pointer\JsonPointer::document(); $schemaValidator = new SchemaValidator\SchemaValidator(); $result = $schemaValidator->validate( $json, $schema, $jsonPointer ); var_dump($result->isValid()); // bool var_dump($result->errors()); // flat list of `ValidationError` value objects
Changelog
The maintainers of this project record notable changes to this project in a changelog.
Contributing
The maintainers of this project suggest following the contribution guide.
Code of Conduct
The maintainers of this project ask contributors to follow the code of conduct.
General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by sponsoring @localheinz or requesting an invoice for services related to this project.
PHP Version Support Policy
This project supports PHP versions with active and security support.
The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.
Security Policy
This project has a security policy.
License
This project uses the MIT license.
Social
Follow @localheinz and @ergebnis on Twitter.