sixlive / laravel-json-schema-assertions
Laravel JSON Schema assertions
Fund package maintenance!
sixlive
Installs: 155 594
Dependents: 0
Suggesters: 0
Security: 0
Stars: 70
Watchers: 3
Forks: 13
Open Issues: 0
Requires
- php: ^8.0
- laravel/framework: ^8.70|^9.0|^10.0|^11.0
- phpunit/phpunit: ^9.5|^10.0|^11.0
- sixlive/json-schema-assertions: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.2
- orchestra/testbench: ^6.20|^8.0|^9.0
README
JSON Schema schema assertions for Laravel test responses. Uses swaggest/php-json-schema under the hood.
Installation
You can install the package via composer:
> composer require sixlive/laravel-json-schema-assertions
This package uses Laravel's 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
// config/app.php 'providers' => [ sixlive\Laravel\JsonSchemaAssertions\ServiceProvider::class, ]
Configuration
Publish the packages config file:
> 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
:
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
/** @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
> composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Code Style
In addition to the php-cs-fixer rules, StyleCI will apply the Laravel preset.
Linting
> composer styles:lint
Fixing
> composer styles:fix
Security
If you discover any security related issues, please email oss@tjmiller.co instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.