Download the PHP package tyamahori/laravel-openapi-validator without Composer
On this page you can find all versions of the php package tyamahori/laravel-openapi-validator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tyamahori/laravel-openapi-validator
More information about tyamahori/laravel-openapi-validator
Files in tyamahori/laravel-openapi-validator
Package laravel-openapi-validator
Short Description Automatic OpenAPI validation for Laravel HTTP tests
License MIT
Homepage https://github.com/kirschbaum-development/laravel-openapi-validator
Informations about the package laravel-openapi-validator
Laravel OpenAPI Validator
Using an OpenAPI spec is a great way to create and share a contract to which your API adheres. This package will automatically verify both the request and response used in your integration and feature tests wherever the Laravel HTTP testing methods (->get('/uri')
, etc) are used.
Behind the scenes this package connects the Laravel HTTP helpers to The PHP League's OpenAPI Validator.
Installation
You can install the package via composer:
Setup
In any feature/integration test (such as those that extend the framework's Tests\TestCase
base class), add the ValidatesOpenApiSpec
trait:
In many situations, the defaults should handle configuration. If you need to customize your configuration (namely the location of the openapi.yaml
or openapi.json
file), publish the config with:
and configure the path to the OpenAPI spec in config/openapi_validator.php
to fit your needs.
Usage
After applying the trait to your test class, anytime you interact with an HTTP test method (get
, post
, put
, delete
, postJson
, call
, etc), the validator will validate both the request and the response.
Skipping Validation
Especially when initially writing tests (such as in TDD), it can be helpful to turn off the request or response validation until the tests are closer to complete. You can do so as follows:
You are free to chain these methods as shown above, or call them on their own:
Keep in mind that withoutRequestValidation()
, withoutResponseValidation()
, and withoutValidation()
only apply to the next request/response and will reset afterwards.
Skipping Responses Based on Response Code
We assume, by default, that any 5xx
status code should not be validated. You may change this by setting the protected responseCodesToSkip
property on your test class, or by using the skipResponseCode
method to add response codes (single, array, or a regex pattern):
Authentication/Authorization
In most tests, you're likely using Laravel's helpers such as actingAs($user)
to handle auth. This package, by default, assumes you're using bearer token as an authorization header, and that this is specified in your OpenAPI spec. The validator will expect the authorization to be part of the request, even though Laravel does not send them. If you are using security other than a bearer token, you should override the getAuthenticatedRequest
method and add the appropriate headers. Note that they do not need to be valid (unless your code will check them), they just need to be present to satisfy the validator.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] or [email protected] instead of using the issue tracker.
Credits
Sponsorship
Development of this package is sponsored by Kirschbaum Development Group, a developer driven company focused on problem solving, team building, and community. Learn more about us or join us!
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-openapi-validator with dependencies
illuminate/support Version ^6.0|^7.0|^8.0|^9.0|^10.0
league/openapi-psr7-validator Version ^0.14|^0.15|^0.16|^0.17
nyholm/psr7 Version ^1.3
symfony/psr-http-message-bridge Version ^2.0