rygilles / laravel-openapi-schema-generator
Generate OpenAPI schema from your Laravel Api project.
Installs: 606
Dependents: 1
Suggesters: 0
Security: 0
Stars: 12
Watchers: 3
Forks: 3
Open Issues: 1
pkg:composer/rygilles/laravel-openapi-schema-generator
Requires
- php: >=5.5.0
- laravel/framework: ~5.4
- phpdocumentor/reflection-docblock: 3.1.*
Requires (Dev)
- phpunit/phpunit: ~4.0 || ~5.0
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