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上的支持

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