Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sixlive/laravel-json-schema-assertions
JSON Schema assertions for the Laravel framework
https://github.com/sixlive/laravel-json-schema-assertions
json-schema laravel php phpunit
Last synced: 1 day ago
JSON representation
JSON Schema assertions for the Laravel framework
- Host: GitHub
- URL: https://github.com/sixlive/laravel-json-schema-assertions
- Owner: sixlive
- License: mit
- Created: 2018-07-01T17:11:56.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T14:54:07.000Z (5 months ago)
- Last Synced: 2025-01-15T00:16:55.193Z (9 days ago)
- Topics: json-schema, laravel, php, phpunit
- Language: PHP
- Homepage:
- Size: 74.2 KB
- Stars: 70
- Watchers: 3
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel JSON Schema Assertions
[](https://packagist.org/packages/sixlive/laravel-json-schema-assertions)
[](https://packagist.org/packages/sixlive/laravel-json-schema-assertions)
[](https://github.styleci.io/repos/139347110)
JSON Schema schema assertions for Laravel test responses. Uses [swaggest/php-json-schema](https://github.com/swaggest/php-json-schema) under the hood.
## Installation
You can install the package via composer:
```bash
> composer require sixlive/laravel-json-schema-assertions
```
This package uses Laravel's [package discovery](https://laravel.com/docs/5.6/packages#package-discovery) to register the service provider to the framework. If you are using an older version of Laravel or do not use package discovery see below.
Provider registration
```php
// config/app.php
'providers' => [
sixlive\Laravel\JsonSchemaAssertions\ServiceProvider::class,
]
```
### Configuration
Publish the packages config file:
```bash
> php artisan vendor:publish --provider="sixlive\Laravel\JsonSchemaAssertions\ServiceProvider" --tag="config"
```
This is the contents of the file which will be published at `config/json-schema-assertions`:
```php
return [
'schema_base_path' => base_path('schemas'),
];
```
## 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.
```
├── app
├── bootstrap
├── config
├── database
├── public
├── resources
├── routes
├── schemas
│ ├── bar.json
│ └── foo.json
├── storage
├── tests
└── vendor
```
```php
/** @test */
public function it_has_a_valid_response()
{
$schema = [
'type' => 'object',
'properties' => [
'foo' => [
'type' => 'string',
],
],
'required' => [
'foo',
],
];
$response = $this->get('/foo');
// Schema as an array
$response->assertJsonSchema($schema);
// Schema from raw JSON
$response->assertJsonSchema(json_encode($schema));
// Schema from a file
$response->assertJsonSchema(base_path('schemas/foo.json'));
// Schema from config path
$response->assertJsonSchema('foo');
// Remote schema
$response->assertJsonSchema('https://docs.foo.io/schemas/foo.json');
}
```
## 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.