jessekoska/swagger-lume

Swagger integration to Lumen 5

1.0.3 2016-05-09 09:50 UTC

Requires

• php: >=5.5.9
• laravel/lumen-framework: ~5.0
• zircote/swagger-php: ~2.0

Requires (Dev)

• codeclimate/php-test-reporter: ^0.2.0
• vlucas/phpdotenv: ^2.2

MIT

• Darius Matulionis

• laravel
• swagger
• lumen

README

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.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

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.