Laravel OpenApi Testing

This packages is based on ensi/openapi-httpfoundation-testing and provides ValidatesAgainstOpenApiSpec trait

Installation

You can install the package via composer:

composer require ensi/laravel-openapi-testing --dev

Version Compatibility

Laravel OpenApi Testing	PHP
^0.1.0	^8.0
^0.2.0	^8.0
^0.3.0	^8.0
^0.4.0	^8.1

Basic usage

Let's add validation according to oas3 to our tests. All we need is to use ValidatesAgainstOpenApiSpec; and implement getOpenApiDocumentPath(): string method like that:

class SomeTestCase extends AnotherTestCase
{
    use ValidatesAgainstOpenApiSpec;

    protected function getOpenApiDocumentPath(): string
    {
        return public_path('api-docs/v1/index.yaml');
    }
}

The trait overrides $this->call method to add the needed validation As a result all http related helper methods ($this->get(), $this->postJson() and e.t.c) perform the validation too. Both request and response is validated to match some part of the given spec. If validation fails your tests is automatically marked as failed, no need to need any manual assertions.

Turning validation off

In some cases you may want to turn validation for a specific request. Here is an example how to do it:

// Turn off validation for both request
$this->skipNextOpenApiRequestValidation()->getJson(...);

// Turn off validation for both response
$this->skipNextOpenApiResponseValidation()->getJson(...);

// Turn off validation for both request and response
$this->skipNextOpenApiValidation()->getJson(...);

Mapping paths

In order to validate request against oas3 the package need to map it to one of the paths described in specification document. We use path from Laravel's route ($request->route()->uri) for that purpose. If it does not fully match in your case you can explicitly set OpenApi path for the current request like that:

$this->forceOpenApiPath('/pets/{petId}')->getJson(...);

Contributing

Please see CONTRIBUTING for details.

Testing

1. composer install
2. composer test

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

The MIT License (MIT). Please see License File for more information.