Swagger 2.0 for Laravel >=5.1
This package is a wrapper of Swagger-php and swagger-ui adapted to work with Laravel 5.
Laravel | Swagger UI | OpenAPI Spec compatibility | L5-Swagger |
---|---|---|---|
5.7.x OR 5.6.x | 3 | 3.0, 2.0 | composer require "darkaonline/l5-swagger:5.7.*" !!! run composer require 'zircote/swagger-php:2.*' if you need old @SWG (SWAGGER annotations) support. !!! |
5.6.x | 3 | 2.0 | composer require "darkaonline/l5-swagger:5.6.*" |
5.5.x | 3 | 2.0 | composer require "darkaonline/l5-swagger:5.5.*" |
5.4.x | 3 | 2.0 | composer require "darkaonline/l5-swagger:5.4.*" |
5.4.x | 2.2 | 1.1, 1.2, 2.0 | composer require "darkaonline/l5-swagger:~4.0" |
5.3.x | 2.2 | 1.1, 1.2, 2.0 | composer require "darkaonline/l5-swagger:~3.0" |
5.2.x | 2.2 | 1.1, 1.2, 2.0 | composer require "darkaonline/l5-swagger:~3.0" |
5.1.x | 2.2 | 1.1, 1.2, 2.0 | composer require "darkaonline/l5-swagger:~3.0" |
You can publish L5-Swagger's config and view files into your project by running:
$ php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
For Laravel >=5.5, no need to manually add L5SwaggerServiceProvider
into config. It uses package auto discovery feature. Skip this if you are on >=5.5, if not:
Open your AppServiceProvider
(located in app/Providers
) and add this line in register
function
$this->app->register(\L5Swagger\L5SwaggerServiceProvider::class);
or open your config/app.php
and add this line in providers
section
L5Swagger\L5SwaggerServiceProvider::class,
In order to generate the Swagger/OpenApi documentation for your API, Swagger offers a set of annotations to declare and manipulate the output. These annotations can be added in your controller, model or even a seperate file. An example of OpenApi annotations can be found here and Swagger annotations can be found here. For more info check out Swagger's "pet store" example or the Swagger OpenApi Specification.
After the annotiations have been added you can run php artisan l5-swagger:generate
to generate the documentation. Alternatively, you can set L5_SWAGGER_GENERATE_ALWAYS
to true
in your .env
file so that your documentation will automatically be generated. Make sure your settings in config/l5-swagger.php
are complete.
If still using Swagger @SWG annotations in you project you should:
- Explicitly require
swagger-php
version 2.* in your projects composer by running:
composer require 'zircote/swagger-php:2.*'
- Set environment variable
SWAGGER_VERSION
to 2.0 in your.env
file:
SWAGGER_VERSION=2.0
or in your config/l5-swagger.php
:
'swagger_version' => env('SWAGGER_VERSION', '2.0'),
The easiest way to build and test your Laravel-based API using Swagger-php is to use Passport's CreateFreshApiToken
middleware. This middleware, built into Laravel's core, adds a cookie to all responses, and the cookie authenticates all subsequent requests through Passport's TokenGuard
.
To get started, first publish L5-Swagger's config and view files into your own project:
$ php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
Next, edit your config/l5-swagger.php
configuration file. Locate the l5-swagger.routes.middleware
section, and add the following middleware list to the api
route:
'api' => [
\App\Http\Middleware\EncryptCookies::class,
\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
\Illuminate\Session\Middleware\StartSession::class,
\Illuminate\View\Middleware\ShareErrorsFromSession::class,
\App\Http\Middleware\VerifyCsrfToken::class,
\Illuminate\Routing\Middleware\SubstituteBindings::class,
\Laravel\Passport\Http\Middleware\CreateFreshApiToken::class,
'auth',
]
One of the setting I find useful to enable is l5-swagger.generate_always
, which will cause your Swagger doc to be regenerated each time you load the Swagger UI (not intended for production use!). All you have to do to enable this in your dev environment is add an environment variable to .env
named L5_SWAGGER_GENERATE_ALWAYS
and set it to true
.
Follow instruction in issue #57.
- Swagger UI 3.
- Configuration changes.
- Assets dependency dropped. Now includes from composer package.
- See migration
- Laravel 5.4 support
- Middleware support for routes (#43) (@tantam)
- Allow to change swagger base path in generation process
- Allow to define constants in config which can be used later in annotations
- Tests fix form L5.3 and PHP >= 5.6
- Update swagger UI to 2.1.5
- Closure routes moved to controller and got names (thanks to @bbs-smuller #19)
- Added option to rename generated API .json file name
- More accurate naming and structured config
- Swagger UI - v2.1.4
- Tests
- Replace
$this->app->register('\Darkaonline\L5Swagger\L5SwaggerServiceProvider');
with$this->app->register(\L5Swagger\L5SwaggerServiceProvider::class);
in yourAppServiceProvider
or add\L5Swagger\L5SwaggerServiceProvider::class
line in yourconfig/app.php
file - Run
l5-swagger:publish-config
to publish new config and make your changes if needed - Remove
public/vendor/l5-swagger
directory - Remove
resources/views/vendor/l5-swagger
directory - Run
l5-swagger:publish-assets
to publish new swagger-ui assets - Run
l5-swagger:publish-views
to publish new views
- 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 your
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.
Hey dude! Help me out for a couple of ๐ป!