jessekoska/swagger-lume
Swagger integration to Lumen 5
28
| Install | |
|---|---|
composer require jessekoska/swagger-lume |
|
| Latest Version: | v0.1 |
| PHP: | >=5.5.9 |
| License: | MIT |
| Last Updated: | Aug 8, 2016 |
| Links: | GitHub · Packagist |
Maintainer: jessekoska
SwaggerLume
Swagger 2.0 for Lumen 5
This package is a wrapper of Swagger-php and swagger-ui adapted to work with Lumen 5.
Martin Abelson Sahlen version of swagger-ui implemented.
Installation
composer require "jessekoska/swagger-lume dev-master"
- Open your
bootstrap/app.phpfile 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);
- Run
php artisan swagger-lume:publish-configto publish configs (config/swagger-lume.php) - Make configuration changes if needed
- Run
php artisan swagger-lume:publishto publish everything
Configuration
- Run
php artisan swagger-lume:publish-configto publish configs (config/swagger-lume.php) - Run
php artisan swagger-lume:publish-assetsto publish swagger-ui to your public folder (public/vendor/swagger-lume) - Run
php artisan swagger-lume:publish-viewsto publish views (resources/views/vendor/swagger-lume) - Run
php artisan swagger-lume:publishto publish everything - Run
php artisan swagger-lume:generateto 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.