haotx/swagger-lume

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Swagger integration to Lumen 5

1.0.0 2016-05-20 03:11 UTC

This package is not auto-updated.

Last update: 2021-06-12 01:37:41 UTC


README

Build Status Test Coverage Code Climate StyleCI Total Downloads

SwaggerLume

Swagger 2.0 for Lumen 5

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

Original source

https://github.com/DarkaOnLine/SwaggerLume

Installation

    composer require "haotx/swagger-lume 1.*"
  • 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 swagger-lume:publish to publish everything

Configuration

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