README

信息

此包已被克隆用于定义一组CORS头信息，这些信息将被包含在默认响应对象中。

目前尚未编辑其他逻辑。

所有荣誉都归功于原始"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的好例子，请参阅此处。

#以下链接支持DarkaOnLine

在Beerpay上支持

嘿，老兄！帮助我几个 🍻！