README

SwaggerLume

Swagger 2.0-3.0 for Lumen

此包是Swagger-php和swagger-ui的包装，适用于Lumen。

安装

• 打开您的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所做的一切都是将swagger-php和swagger-ui包装成Laravel友好的方式，并尝试使其易于托管。有关如何使用swagger-php的信息，请查看此处。有关swagger-php的实际操作示例，请查看此处。

在Beerpay上提供支持

嘿，伙计！帮帮我吧，来一杯🍻！