README

L5 Swagger

Swagger 2.0 for Laravel >=5.1

本包是swagger-php和swagger-ui的包装器，适应于Laravel 5使用。

安装

对于Swagger 2.0

对于Swagger 1.0

composer require darkaonline/l5-swagger

打开你的AppServiceProvider（位于app/Providers）并在register函数中添加此行

$this->app->register(\L5Swagger\L5SwaggerServiceProvider::class);

或者打开你的config/app.php并在providers部分添加此行

L5Swagger\L5SwaggerServiceProvider::class,

对于Laravel 5.5，无需手动将L5SwaggerServiceProvider添加到配置中。它使用包自动发现功能。

5.0版本中的变化

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

4.0版本中的变化

• Laravel 5.4支持

3.2.1版本中的变化

• 对路由支持中间件 (#43) (@tantam)

3.2版本中的变化

• 允许在生成过程中更改swagger基本路径
• 允许在配置中定义常量，这些常量可以在后续的注释中使用
• 测试修复了L5.3和PHP >= 5.6
• 更新swagger UI到2.1.5

3.1版本中的变化

• 闭包路由移动到控制器并命名（感谢 @bbs-smuller #19）
• 添加了重命名生成API.json文件名的选项

3.0版本中的变化

• 更精确的命名和结构化配置
• Swagger UI - v2.1.4
• 测试

从2.0迁移到3.0

• 在您的AppServiceProvider中将$this->app->register('\Darkaonline\L5Swagger\L5SwaggerServiceProvider');替换为$this->app->register(\L5Swagger\L5SwaggerServiceProvider::class);，或者在您的config/app.php文件中添加\L5Swagger\L5SwaggerServiceProvider::class行
• 运行l5-swagger:publish-config以发布新配置并根据需要做出更改
• 删除public/vendor/l5-swagger目录
• 删除resources/views/vendor/l5-swagger目录
• 运行l5-swagger:publish-assets以发布新的swagger-ui资产
• 运行l5-swagger:publish-views以发布新视图

从3.0|4.0迁移到5.0

• 删除config/l5-swagger.php文件（如果需要，请先复制）
• 删除public/vendor/l5-swagger目录
• 删除resources/views/vendor/l5-swagger目录
• 运行l5-swagger:publish以发布新的swagger-ui视图和配置
• 编辑您的config/l5-swagger.php文件

配置

• 运行l5-swagger:publish以发布所有内容
• 运行l5-swagger:publish-config以发布配置（config/l5-swagger.php）
• 运行l5-swagger:publish-assets以将swagger-ui发布到您的public文件夹（public/vendor/l5-swagger）
• 运行l5-swagger:publish-views以发布视图（resources/views/vendor/l5-swagger）-仅适用于版本<= 4.0
• 运行l5-swagger:generate以生成文档或设置您的配置或.env文件中的generate_always参数为true

Swagger-php

实际的Swagger规范超出了本包的范围。L5-Swagger所做的只是将swagger-php和swagger-ui包装在Laravel友好的方式中，并尝试使其易于服务。有关如何使用swagger-php的信息，请查看此处。有关swagger-php在实际操作中的良好示例，请查看此处。

通过Beerpay提供支持

嘿，兄弟！帮帮我，给我几杯🍻！