Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sixlive/json-schema-assertions
JSON Schema assertions for PHP
https://github.com/sixlive/json-schema-assertions
json-schema phpunit
Last synced: about 1 month ago
JSON representation
JSON Schema assertions for PHP
- Host: GitHub
- URL: https://github.com/sixlive/json-schema-assertions
- Owner: sixlive
- License: mit
- Created: 2018-09-03T13:21:37.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T15:30:29.000Z (4 months ago)
- Last Synced: 2024-11-08T20:49:31.561Z (about 2 months ago)
- Topics: json-schema, phpunit
- Language: PHP
- Homepage:
- Size: 25.4 KB
- Stars: 4
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# JSON Schema Assertions
[](https://packagist.org/packages/sixlive/json-schema-assertions)
[](https://packagist.org/packages/sixlive/json-schema-assertions)
[](https://github.styleci.io/repos/147207965)
JSON Schema schema assertions for PHP. Uses [swaggest/php-json-schema](https://github.com/swaggest/php-json-schema) under the hood.
## Framework Integrations
* [Laravel](https://github.com/sixlive/laravel-json-schema-assertions)
## Installation
You can install the package via composer:
```bash
> composer require --dev sixlive/json-schema-assertions
```
## Usage
If you are making use of external schema refrences e.g. `$ref: 'bar.json`, you must reference the schema through file path or using the config path resolution.
```
├── schemas
│ ├── bar.json
│ └── foo.json
```
You can either use the `AssertsJsonSchema` trait or manually construct the schema assertion.
```php
use sixlive\JsonSchemaAssertions\Concerns\AssertJsonSchema;
class ExampleTest extends TestCase
{
use AssertsJsonSchema;
public function setUp()
{
parent::setUp();
$this->setJsonSchemaBasePath(__DIR__.'/../Schemas');
}
/** @test */
function it_has_a_valid_response()
{
$this->schemaAssertion
->schema('foo')
->assert('{"foo": "bar"}');
}
}
```
```php
/** @test */
public function it_has_a_valid_response()
{
$schema = [
'type' => 'object',
'properties' => [
'foo' => [
'type' => 'string',
],
],
'required' => [
'foo',
],
];
// Schema as an array
(new SchemaAssertion)->schema($schema)->assert('{"foo": "bar"}');
// Schema from raw JSON
(new SchemaAssertion)->schema(json_encode($schema))->assert('{"foo": "bar"}');
// Schema from a file
(new SchemaAssertion)->schema(__DIR__.'/../schemas/foo.json'))
->assert('{"foo": "bar"}');
// Remote schema
(new SchemaAssertion)->schema('https://docs.foo.io/schemas/foo.json')
->assert('{"foo": "bar"}')
// Schema from a path
(new SchemaAssertion(__DIR__.'/../schemas/'))
->schema('foo')
->assert('{"foo": "bar"}');
}
```
## Testing
``` bash
> composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Code Style
In addition to the php-cs-fixer rules, StyleCI will apply the [Laravel preset](https://docs.styleci.io/presets#laravel).
### Linting
```bash
> composer styles:lint
```
### Fixing
```bash
> composer styles:fix
```
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [TJ Miller](https://github.com/sixlive)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.