Download the PHP package lumen-utils/swagger-lumen without Composer
On this page you can find all versions of the php package lumen-utils/swagger-lumen. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lumen-utils/swagger-lumen
More information about lumen-utils/swagger-lumen
Files in lumen-utils/swagger-lumen
Package swagger-lumen
Short Description OpenApi or Swagger integration to Lumen
License MIT
Informations about the package swagger-lumen
SwaggerLume
Swagger 2.0-3.0 for Lumen
This package is a wrapper of Swagger-php and swagger-ui adapted to work with Lumen.
Installation
Lumen | Swagger UI | OpenAPI Spec compatibility | L5-Swagger |
---|---|---|---|
10.0 | 3 | 2.0, 3.0 |
- Open your
bootstrap/app.php
file and:
uncomment this line (around line 26) in Create The Application
section:
add this line before Register Container Bindings
section:
add this line in Register Service Providers
section:
- Run
php artisan swagger-lume:publish-config
to publish configs (config/swagger-lume.php
) - Make configuration changes if needed
- Run
php artisan swagger-lume:publish
to publish everything
Using OpenApi 3.0 Specification
If you would like to use latest OpenApi specifications (originally known as the Swagger Specification) in your project you should:
-
Explicitly require
swagger-php
version 3.* in your projects composer by running: - Set environment variable
SWAGGER_VERSION
to 3.0 in your.env
file:
or in your config/l5-swagger.php
:
- Use examples provided here: https://github.com/zircote/swagger-php/tree/3.x/Examples/petstore-3.0
Configuration
- Run
php artisan swagger-lume:publish-config
to publish configs (config/swagger-lume.php
) - Run
php artisan swagger-lume:publish-views
to publish views (resources/views/vendor/swagger-lume
) - Run
php artisan swagger-lume:publish
to publish everything - Run
php artisan swagger-lume:generate
to generate docs
Swagger-php
The actual Swagger spec is beyond the scope of this package. All SwaggerLume 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.
All versions of swagger-lumen with dependencies
laravel/lumen-framework Version ^10.0
zircote/swagger-php Version ~4.7.15
swagger-api/swagger-ui Version ^5.10.3
symfony/yaml Version ^6.2