swaggerlume's Introduction

SwaggerLume

Swagger 2.0 for Lumen 5

This package is a wrapper of Swagger-php and swagger-ui adapted to work with Lumen 5.

Installation

Lumen	SwaggerLume
5.0 - 5.3	`composer require "darkaonline/swagger-lume:~1.0"`
5.4.x	`composer require "darkaonline/swagger-lume:~2.0"`

Open your 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);

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

Configuration

Run php artisan swagger-lume:publish-config to publish configs (config/swagger-lume.php)
Run php artisan swagger-lume:publish-assets to publish swagger-ui to your public folder (public/vendor/swagger-lume)
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

Changes in 2.0

Lumen 5.4 support
Swagger UI 2.2.8

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.

Recommend Projects