README

SwaggerLume

Swagger 2.0 for Lumen 5

本包是Swagger-php和swagger-ui的封装，适配于Lumen 5。

安装

• 打开你的bootstrap/app.php文件，

在创建应用程序部分取消注释这行代码（大约在第26行）

     $app->withFacades();

在注册容器绑定部分之前添加这行代码

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

在注册服务提供者部分添加这行代码

    $app->register(\SwaggerLume\ServiceProvider::class);

• 运行php artisan swagger-lume:publish-config来发布配置（config/swagger-lume.php）
• 如有需要，进行配置更改
• 运行php artisan swagger-lume:publish来发布所有内容

使用OpenApi 3.0规范

如果你想在项目中使用较新的OpenApi规范（最初被称为Swagger规范），你应该

• 在你的项目composer中显式要求swagger-php版本3.*，运行

composer require 'zircote/swagger-php:3.*'

• 在.env文件中将环境变量SWAGGER_VERSION设置为3.0

SWAGGER_VERSION=3.0

或在你的config/l5-swagger.php

'swagger_version' => env('SWAGGER_VERSION', '3.0'),

• 使用这里提供的示例：https://github.com/zircote/swagger-php/tree/3.x/Examples/petstore-3.0

配置

• 运行php artisan swagger-lume:publish-config来发布配置（config/swagger-lume.php）
• 运行php artisan swagger-lume:publish-views来发布视图（resources/views/vendor/swagger-lume）
• 运行php artisan swagger-lume:publish来发布所有内容
• 运行php artisan swagger-lume:generate来生成文档

3.0版本中的更改

• Swagger UI 3.
• 配置更改。
• 删除了资产依赖项。现在从composer包中包含。
• 查看从2.0到3.0的迁移

2.0版本中的更改

• Lumen 5.4支持
• Swagger UI 2.2.8

迁移到2.0、3.0或5.5

• 删除config/swagger-lume.php文件（如有需要，先进行备份）
• 删除public/vendor/swagger-lume目录
• 删除resources/views/vendor/swagger-lume目录
• 运行swagger-lume:publish来发布新的swagger-ui视图和配置
• 编辑你的config/swagger-lume.php文件

Swagger-php

实际的Swagger规范超出了本包的范围。SwaggerLume所做的只是以Laravel友好的方式封装swagger-php和swagger-ui，并尝试使其易于提供。有关如何使用swagger-php的信息，请参阅此处。有关swagger-php的实际应用示例，请参阅此处。

在Beerpay上提供支持

嘿，兄弟！帮帮我几个🍻！