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 所做的只是以 Laravel 友好的方式打包 swagger-php 和 swagger-ui，并尝试使其易于提供。有关如何使用 swagger-php 的信息，请参阅此处。有关 swagger-php 的良好示例，请参阅此处。

重要：请确保在所有带有注解的页面上添加包含语句！

use OpenApi\Annotations as OA;

在 Beerpay 上提供支持

嘿，伙计！帮帮我几个 🍻！