rygilles/laravel-openapi-schema-generator

This package is abandoned and no longer maintained. No replacement package was suggested.

Generate OpenAPI schema from your Laravel Api project.

v0.3.3 2018-09-28 10:17 UTC

This package is auto-updated.

Last update: 2023-11-29 02:35:31 UTC


README

Automatically generate your Laravel Api project OpenAPI schema.

Installation

Laravel version >= 5.4 is required.

Require this package with composer using the following command:

$ composer require rygilles/laravel-openapi-schema-generator

Go to your config/app.php and add the service provider:

Rygilles\OpenApiGenerator\OpenApiSchemaGeneratorServiceProvider::class,

Publish configuration file

This package need a configuration file in to work properly.

$ php artisan vendor:publish --tag=openapischemas

After publishing, edit the file located in your Laravel configuration folder in config/openapischemas.php.

@todo : Documentation on config file content

Usage

To generate your API JSONs schemas, use the openApiSchemas:generate artisan command.

@todo : README.md to complete