https://github.com/darkaonline/swaggerlume
Lumen swagger
https://github.com/darkaonline/swaggerlume
lumen lumen-package swagger swagger-php swagger-ui
Last synced: about 1 year ago
JSON representation
Lumen swagger
- Host: GitHub
- URL: https://github.com/darkaonline/swaggerlume
- Owner: DarkaOnLine
- License: mit
- Created: 2016-01-21T14:33:06.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-15T06:18:08.000Z (about 2 years ago)
- Last Synced: 2025-05-15T14:05:23.272Z (about 1 year ago)
- Topics: lumen, lumen-package, swagger, swagger-php, swagger-ui
- Language: PHP
- Size: 2.05 MB
- Stars: 336
- Watchers: 9
- Forks: 84
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/DarkaOnLine/swagger-lume)
[](https://coveralls.io/github/DarkaOnLine/SwaggerLume?branch=master)
[](https://codeclimate.com/github/DarkaOnLine/SwaggerLume)
[](https://styleci.io/repos/50113229)
SwaggerLume
==========
Swagger 2.0-3.0 for Lumen
This package is a wrapper of [Swagger-php](https://github.com/zircote/swagger-php) and [swagger-ui](https://github.com/swagger-api/swagger-ui) adapted to work with Lumen.
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:
```php
$app->withFacades();
```
add this line before `Register Container Bindings` section:
```php
$app->configure('swagger-lume');
```
add this line in `Register Service Providers` section:
```php
$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](https://github.com/OAI/OpenAPI-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:
```bash
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`:
```php
'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
============
- Swagger UI 3.
- Configuration changes.
- Assets dependency dropped. Now includes from composer package.
- [See migration from 2.0 to 3.0](#migrate-from-20-to-30-or-55)
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](http://zircote.com/swagger-php/). For good examples of swagger-php in action [look here](https://github.com/zircote/swagger-php/tree/master/Examples/petstore.swagger.io).
**Important:** Make sure that you add the include statement on all pages with annotations!
```
use OpenApi\Annotations as OA;
```
## Support on Beerpay
Hey dude! Help me out for a couple of :beers:!
[](https://beerpay.io/DarkaOnLine/SwaggerLume) [](https://beerpay.io/DarkaOnLine/SwaggerLume?focus=wish)