Download the PHP package kentaroutakeda/laravel-openapi-validator without Composer

Laravel OpenAPI Validator

Request and response validators based on the OpenAPI Specification.

Summary

• Validate any request and response with a pre-prepared OpenAPI Spec.
• Automatically load specs from Laravel OpenAPI or L5 Swagger.
• You can also load your own specs without using these libraries.
• You can customize validation and error logging behavior on a per-route or application-wide basis.
• Can display Swagger UI. You can view the documentation and test the API.

Requirements

• PHP 8.1 or higher
• Laravel 9.0 or higher

Installation

You can install the package via composer:

Usage

1. Configure OpenAPI Specification

   If you're using Laravel OpenAPI, you don't need to do anything.

   For L5 Swagger, the following settings are required:

   How to load your own schema without using these packages will be explained later.

2. Register Middleware

   Routes with this setting will be validated for all requests including Feature Tests, and depending on the settings, responses as well.

   NOTE:
   This repository's ./e2e directory contains working examples for e2e testing. You can see middleware configuration examples in Routing, and actual validations and failures in Tests.

3. (Optional) Customize Middleware

   If necessary, you can change Middleware behavior for each route.

   NOTE:
   Response validation for large amounts of data can take a long time. It would be a good idea to switch on/off validation depending on the route and APP_* environment variables.

4. Deployment

   When deploying your application to production, you should make sure that you run the openapi-validator:cache Artisan command during your deployment process:

   This command caches the OpenAPI Spec defined in your application. If you change the definition for development, you need to clear it as follows:

(Optional) Swagger UI support

You can view the Swagger UI just by installing the package. No additional configuration is required.

1. Install package.

2. Display APP_URL/openapi-validator/documents in browser.

NOTE:
By default, the Swagger UI can only be displayed when APP_DEBUG is enabled.

(Optional) Customization

Publish Configuration

You can publish the config file to change behavior.

Alternatively, most settings can be changed using environment variables. Check the comments in config/openapi-validator.php for details.

Your own schema providers

1. If you want to use your own schema providers, first publish the config.

2. Next, implement a class to retrieve the schema.

3. Finally, set it in your config.

Error responses and customization

By default, it is formatted according to RFC 7807 - Problem Details for HTTP APIs.

Validation errors, stack traces and original response can also be included depending on your settings. For example, it might look like this:

Here's how to change to a different format:

1. First, implement a class to generate a response. For example:

2. Next, register the class to the service container.

Events

If a validation error occurs, an event will be fired depending on the type of error.

• ValidationFailedInterface - All errors
  • RequestValidationFailed - Request validation error
  • ResponseValidationFailed - Response validation error

Contributing and Development

Feel free to open an Issue or add a Pull request.

When adding a pull request, please refer to the following setup steps.

License

Laravel OpenAPI Validator is open-sourced software licensed under the MIT license.