56 lines
1.7 KiB
Markdown
56 lines
1.7 KiB
Markdown
|
# JSON Schema for PHP
|
||
|
|
|
||
|
|
[](https://travis-ci.org/justinrainbow/json-schema)
|
||
|
|
[](https://packagist.org/packages/justinrainbow/json-schema)
|
||
|
|
[](https://packagist.org/packages/justinrainbow/json-schema)
|
||
|
|
|
||
|
|
A PHP Implementation for validating `JSON` Structures against a given `Schema`.
|
||
|
|
|
||
|
|
See [json-schema](http://json-schema.org/) for more details.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
### Library
|
||
|
|
|
||
|
|
$ git clone https://github.com/justinrainbow/json-schema.git
|
||
|
|
|
||
|
|
### Dependencies
|
||
|
|
|
||
|
|
#### [`Composer`](https://github.com/composer/composer) (*will use the Composer ClassLoader*)
|
||
|
|
|
||
|
|
$ wget http://getcomposer.org/composer.phar
|
||
|
|
$ php composer.phar require justinrainbow/json-schema:~1.3
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
|
||
|
|
// Get the schema and data as objects
|
||
|
|
$retriever = new JsonSchema\Uri\UriRetriever;
|
||
|
|
$schema = $retriever->retrieve('file://' . realpath('schema.json'));
|
||
|
|
$data = json_decode(file_get_contents('data.json'));
|
||
|
|
|
||
|
|
// If you use $ref or if you are unsure, resolve those references here
|
||
|
|
// This modifies the $schema object
|
||
|
|
$refResolver = new JsonSchema\RefResolver($retriever);
|
||
|
|
$refResolver->resolve($schema, 'file://' . __DIR__);
|
||
|
|
|
||
|
|
// Validate
|
||
|
|
$validator = new JsonSchema\Validator();
|
||
|
|
$validator->check($data, $schema);
|
||
|
|
|
||
|
|
if ($validator->isValid()) {
|
||
|
|
echo "The supplied JSON validates against the schema.\n";
|
||
|
|
} else {
|
||
|
|
echo "JSON does not validate. Violations:\n";
|
||
|
|
foreach ($validator->getErrors() as $error) {
|
||
|
|
echo sprintf("[%s] %s\n", $error['property'], $error['message']);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Running the tests
|
||
|
|
|
||
|
|
$ vendor/bin/phpunit
|