Downloads
Stars
Version
Swagger 2.0 for Laravel >=5.1
This package is a wrapper of Swagger-php and swagger-ui adapted to work with Laravel 5.
For Swagger 2.0
Laravel | Swagger UI | OpenAPI Spec compatibility | L5-Swagger |
---|---|---|---|
5.1.x | 2.2 | 1.1, 1.2, 2.0 | php composer require "darkaonline/l5-swagger:~3.0" |
5.2.x | 2.2 | 1.1, 1.2, 2.0 | php composer require "darkaonline/l5-swagger:~3.0" |
5.3.x | 2.2 | 1.1, 1.2, 2.0 | php composer require "darkaonline/l5-swagger:~3.0" |
5.4.x | 2.2 | 1.1, 1.2, 2.0 | php composer require "darkaonline/l5-swagger:~4.0" |
5.4.x | 3 | 2.0 | php composer require "darkaonline/l5-swagger:5.4.*" |
5.5.x | 3 | 2.0 | php composer require "darkaonline/l5-swagger:5.5.*" |
For Swagger 1.0
composer require darkaonline/l5-swagger
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,
For Laravel 5.5, no need to manually add L5SwaggerServiceProvider
into config. It uses package auto discovery feature.
$this->app->register('\Darkaonline\L5Swagger\L5SwaggerServiceProvider');
with $this->app->register(\L5Swagger\L5SwaggerServiceProvider::class);
in your AppServiceProvider
or add \L5Swagger\L5SwaggerServiceProvider::class
line in your config/app.php
filel5-swagger:publish-config
to publish new config and make your changes if neededpublic/vendor/l5-swagger
directoryresources/views/vendor/l5-swagger
directoryl5-swagger:publish-assets
to publish new swagger-ui assetsl5-swagger:publish-views
to publish new viewsconfig/l5-swagger.php
file (make a copy if needed)public/vendor/l5-swagger
directoryresources/views/vendor/l5-swagger
directoryl5-swagger:publish
to publish new swagger-ui view and configurationconfig/l5-swagger.php
filel5-swagger:publish
to publish everythingl5-swagger:publish-config
to publish configs (config/l5-swagger.php
)l5-swagger:publish-assets
to publish swagger-ui to your public folder (public/vendor/l5-swagger
)l5-swagger:publish-views
to publish views (resources/views/vendor/l5-swagger
) - only for versions <= 4.0l5-swagger:generate
to generate docs or set generate_always
param to true
in your config or .env fileThe 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 :beers:!