chinmay/open-api-laravel

Laravel Open API Schema Generator

dev-main 2024-03-31 18:29 UTC

Requires

• php: ^8.1
• chinmay/open-api: dev-main
• illuminate/routing: ^9.0|^10.0|^11.0
• illuminate/support: ^9.0|^10.0|^11.0

Requires (Dev)

• friendsofphp/php-cs-fixer: dev-master

MIT

• Chinmay Purav

README

This package is aimed at generating OpenAPI specification schema by parsing the api routes and form request classes.

Usage

Installation

To install this package locally, run the following command

composer require chinmay/open-api-laravel --dev

Configuration

The routes to be included/excluded, schema path, etc. are configured via openapi.php config file.

To publish the file run the following command.

php artisan vendor:publish --tag=openapi

Generate Schema

To generate schema run the following command

php artisan openapi:generate

License

This project is licensed under the MIT License.

Status

Work in Progress: This project is actively being developed