Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grizz-it/json-schema
JSON schema validator.
https://github.com/grizz-it/json-schema
json-schema php validation validator
Last synced: about 2 months ago
JSON representation
JSON schema validator.
- Host: GitHub
- URL: https://github.com/grizz-it/json-schema
- Owner: grizz-it
- License: mit
- Created: 2021-02-24T13:20:52.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-24T13:23:01.000Z (almost 4 years ago)
- Last Synced: 2024-03-25T20:56:26.019Z (9 months ago)
- Topics: json-schema, php, validation, validator
- Language: PHP
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.com/grizz-it/json-schema)
# GrizzIT JSON Schema
This package contains a [JSON schema](https://json-schema.org/) validator
library for PHP. It support Draft 07 and 06.
To get a grip on JSON schema's, what they are and how they work, please see the
manual of [json-schema-org](https://json-schema.org/learn/).
The package generates a reusable validation object, which can be used to verify
data against.
## Installation
To install the package run the following command:
```
composer require grizz-it/json-schema
```
## Usage
Before a validation object can be created, the factory for the validators needs
to be instantiated. This can be done by using the following snippet:
```php
create($schema);
```
It is also possible to create a verified validation object.
This is possible when the `$schema` property is set on the
provided schema. The schema will then be validated against
the schema which is defined on the property. This can be
done with the following snippet:
```php
createVerifiedValidator($schema);
```
### Local file
To create a validator object from a local schema file, it is also possible to
reference this file location to a method and let this method load it. This
can be done with the following snippet:
```php
createFromLocalFile('path/to/my/schema.json');
```
### Remote file
A schema can also be loaded from a remote location, for example:
[http://json-schema.org/draft-07/schema#](http://json-schema.org/draft-07/schema#).
To load a schema from a remote location, use the following method:
```php
createFromRemoteFile('http://json-schema.org/draft-07/schema#');
```
### From string
If a validation object needs to be created from a JSON string, use the method
`createFromString`.
```php
createFromString(
'{"$ref": "http://json-schema.org/draft-07/schema#"}'
);
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
## MIT License
Copyright (c) GrizzIT
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.