Swagger 2.0 for Laravel >=5.1
This package is a wrapper of Swagger-php and swagger-ui adapted to work with Laravel 5.
Full credit to DarkaOnLine/L5-Swagger for creating this package originally.
composer require "damian-nz/l5-swagger:~4.0"
Thanks to package auto discovery in Laravel 5.5, that's it!
- Remove
config/l5-swagger.php
file (make a copy if needed) - Remove
public/vendor/l5-swagger
directory - Remove
resources/views/vendor/l5-swagger
directory - Run
l5-swagger:publish
to publish new swagger-ui view and configuration - Edit the newly published
config/l5-swagger.php
file
- Run
l5-swagger:publish
to publish everything - Run
l5-swagger:publish-config
to publish configs (config/l5-swagger.php
) - Run
l5-swagger:publish-assets
to publish swagger-ui to your public folder (public/vendor/l5-swagger
) - Run
l5-swagger:publish-views
to publish views (resources/views/vendor/l5-swagger
) - only for versions <= 4.0 - Run
l5-swagger:generate
to generate docs or setgenerate_always
param totrue
in your config or .env file
The actual Swagger spec is beyond the scope of this package. All L5-Swagger does is package up swagger-php and swagger-ui in a Laravel-friendly fashion, and tries to make it easy to serve. For info on how to use swagger-php look here. For good examples of swagger-php in action look here.
Help me out the original package creator buy a round of 🍻!