2017 © Pedro Peláez
 

library swagger-lume

Swagger integration to Lumen 5

image

darkaonline/swagger-lume

Swagger integration to Lumen 5

  • Monday, April 9, 2018
  • by DarkaOnLine
  • Repository
  • 11 Watchers
  • 129 Stars
  • 95,698 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 31 Forks
  • 1 Open issues
  • 21 Versions
  • 20 % Grown

The README.md

Total Downloads Build Status Coverage Status Code Climate StyleCI, (*1)

SwaggerLume

Swagger 2.0-3.0 for Lumen, (*2)

This package is a wrapper of Swagger-php and swagger-ui adapted to work with Lumen., (*3)

Installation

Lumen Swagger UI OpenAPI Spec compatibility L5-Swagger
5.0 - 5.3 2.2 1.1, 1.2, 2.0 composer require "darkaonline/swagger-lume:~1.0"
5.4.x 2.2 1.1, 1.2, 2.0 composer require "darkaonline/swagger-lume:~2.0"
5.4.x 3 2.0 composer require "darkaonline/swagger-lume:~3.0"
5.5.x 3 2.0 composer require "darkaonline/swagger-lume:5.5.*"
5.6 - 5.7 3 2.0, 3.0 composer require "darkaonline/swagger-lume:5.6.*"
6.0 3 2.0, 3.0 composer require "darkaonline/swagger-lume:6.*"
7.0 3 2.0, 3.0 composer require "darkaonline/swagger-lume:7.*"
8.0 3 2.0, 3.0 composer require "darkaonline/swagger-lume:8.*"
9.0 3 2.0, 3.0 composer require "darkaonline/swagger-lume:9.*"
10.0 3 2.0, 3.0 composer require "darkaonline/swagger-lume:10.*"
  • Open your bootstrap/app.php file and:

uncomment this line (around line 26) in Create The Application section:, (*4)

     $app->withFacades();

add this line before Register Container Bindings section:, (*5)

     $app->configure('swagger-lume');

add this line in Register Service Providers section:, (*6)

    $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

Using OpenApi 3.0 Specification

If you would like to use latest OpenApi specifications (originally known as the Swagger Specification) in your project you should: - Explicitly require swagger-php version 3.* in your projects composer by running:, (*7)

composer require 'zircote/swagger-php:3.*'
  • Set environment variable SWAGGER_VERSION to 3.0 in your .env file:
SWAGGER_VERSION=3.0

or in your config/l5-swagger.php:, (*8)

'swagger_version' => env('SWAGGER_VERSION', '3.0'),
  • Use examples provided here: https://github.com/zircote/swagger-php/tree/3.x/Examples/petstore-3.0

Configuration

  • Run php artisan swagger-lume:publish-config to publish configs (config/swagger-lume.php)
  • 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 3.0

Changes in 2.0

  • Lumen 5.4 support
  • Swagger UI 2.2.8

Migrate from 2.0 to 3.0 or 5.5

  • Remove config/swagger-lume.php file (make a copy if needed)
  • Remove public/vendor/swagger-lume directory
  • Remove resources/views/vendor/swagger-lume directory
  • Run swagger-lume:publish to publish new swagger-ui view and configuration
  • Edit your config/swagger-lume.php file

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., (*9)

Important: Make sure that you add the include statement on all pages with annotations!, (*10)

use OpenApi\Annotations as OA;

Support on Beerpay

Hey dude! Help me out for a couple of :beers:!, (*11)

Beerpay Beerpay, (*12)

The Versions

09/04 2018

dev-master

9999999-dev

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

09/04 2018

5.6.1

5.6.1.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

28/03 2018

5.6.0

5.6.0.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

28/03 2018

dev-support-open-api-3.0

dev-support-open-api-3.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

28/03 2018

5.5.3

5.5.3.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

28/03 2018

dev-fix-asset-request-schema

dev-fix-asset-request-schema

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

07/02 2018

5.5.2

5.5.2.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

11/01 2018

5.5.1

5.5.1.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

07/09 2017

3.x-dev

3.9999999.9999999.9999999-dev

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

07/09 2017

3.0.1

3.0.1.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

07/09 2017

5.5.0

5.5.0.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

05/09 2017

2.x-dev

2.9999999.9999999.9999999-dev

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

05/09 2017

2.0.1

2.0.1.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

31/08 2017

3.0

3.0.0.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

31/08 2017

dev-swagger-ui-3

dev-swagger-ui-3

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

30/01 2017

2.0

2.0.0.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

25/08 2016

1.0.4

1.0.4.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

09/05 2016

1.0.3

1.0.3.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

30/01 2016

1.0.2

1.0.2.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

28/01 2016

1.0.1

1.0.1.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger

24/01 2016

1.0

1.0.0.0

Swagger integration to Lumen 5

  Sources   Download

MIT

The Requires

 

The Development Requires

by Darius Matulionis

laravel lumen swagger