Download the PHP package evolvo/swagger-doc-generators without Composer
On this page you can find all versions of the php package evolvo/swagger-doc-generators. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download evolvo/swagger-doc-generators
More information about evolvo/swagger-doc-generators
Files in evolvo/swagger-doc-generators
Package swagger-doc-generators
Short Description Artisan commands to generate comments for swagger.
License MIT
Informations about the package swagger-doc-generators
Swagger 5.7 auto comments generator for Laravel
About
The swagger-doc-generators
package allows you to create comments from validation classes for swagger documentation.
Installation
Require the evolvo/swagger-doc-generators
package in your composer.json
and update your dependencies:
add
to config/app.php 'providers' array.
If you don't have swagger config and view files:
Run:
then add
to config/app.php 'providers' array.
Add to app/Http/Controllers/Controller.php:
add to .env file:
L5_SWAGGER_GENERATE_ALWAYS=TRUE
.
Default preview route is http://your-address.com/api/documentation
, but you can change it in configuration.
Usage
Run php artisan comment {METHOD::route}
to generate comment for route. You can specify multiple routes.
Run php artisan comment:controller {controller}
to generate comments for whole controller.
Examples
For single route
php artisan comment GET::api/clients
For multiple routes
php artisan comment GET::api/clients POST::api/clients PUT::api/clients/{client}
For controller
php artisan comment:controller ClientsController
Custom documentation style
Run php artisan swagger-custom-style:apply
to apply custom style.
After that go to config/l5-swagger.php
and change style in css
array.
Example
Run php artisan swagger-custom-style:remove
to remove custom style.
Links and examples
Swagger PHP: here
More about swagger for laravel: l5-swagger.
L5-swagger documentation example: pet store.
Pet store code example: link.
Our company: http://evolvo.eu.
All versions of swagger-doc-generators with dependencies
php Version >=7.0.0
fzaninotto/faker Version ~1.4
darkaonline/l5-swagger Version 5.7.*