Package Data | |
---|---|
Maintainer Username: | Lucifer20211202 |
Maintainer Contact: | Lucifer20211202@protonmail.com (Lucifer) |
Package Create Date: | 2023-11-28 |
Package Last Update: | 2023-11-28 |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-10-31 15:24:35 |
Package Statistics | |
---|---|
Total Downloads: | 675 |
Monthly Downloads: | 23 |
Daily Downloads: | 5 |
Total Stars: | 0 |
Total Watchers: | 0 |
Total Forks: | 0 |
Total Open Issues: | 0 |
Swagger 2.0-3.0 for Lumen
This package is a wrapper of Swagger-php and swagger-ui adapted to work with Lumen.
Lumen | Swagger UI| OpenAPI Spec compatibility | L5-Swagger
:-----------|:----------|:---------------------------|:----------
10.0 | 3 | 2.0, 3.0 | composer require "lumen-utils/swagger-lumen:10.*"
bootstrap/app.php
file and:uncomment this line (around line 26) in Create The Application
section:
$app->withFacades();
add this line before Register Container Bindings
section:
$app->configure('swagger-lume');
add this line in Register Service Providers
section:
$app->register(\SwaggerLume\ServiceProvider::class);
php artisan swagger-lume:publish-config
to publish configs (config/swagger-lume.php
)php artisan swagger-lume:publish
to publish everythingIf you would like to use latest OpenApi specifications (originally known as the Swagger Specification) in your project you should:
swagger-php
version 3.* in your projects composer by running:composer require 'zircote/swagger-php:3.*'
SWAGGER_VERSION
to 3.0 in your .env
file:SWAGGER_VERSION=3.0
or in your config/l5-swagger.php
:
'swagger_version' => env('SWAGGER_VERSION', '3.0'),
php artisan swagger-lume:publish-config
to publish configs (config/swagger-lume.php
)php artisan swagger-lume:publish-views
to publish views (resources/views/vendor/swagger-lume
)php artisan swagger-lume:publish
to publish everythingphp artisan swagger-lume:generate
to generate docsThe 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.