lithiumdev/l5-swagger

此包已被弃用且不再维护。未建议替代包。

适用于Laravel 5.2+的Swagger集成

维护者

详细信息

github.com/lhdev/L5-Swagger

源代码

问题

安装量: 9,449

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

语言:JavaScript

1.0.0 2016-03-08 02:24 UTC

Requires

MIT 3a6cc0e2afe61f6f4a95be5691cd77693eb29d00

  • Troy Siedsma <tsiedsma.woop@lithiumhosting.com>

laravelswaggerapi documenter

This package is auto-updated.

Last update: 2021-11-19 17:46:32 UTC

README

L5-Swagger

来自Lithium Hosting
我们始终欢迎pull请求，欢迎您将其变成自己的项目或帮助我们改进它。

版权

(c) Lithium Hosting, llc

许可证

此库遵循MIT许可证；您可以在文件/LICENSE中找到许可证的完整副本。
灵感来自 Jordan Lapp的Swaggervel！

要求

  • PHP 5.5.9或更高版本
  • Laravel 5.2

描述

此包将Swagger-php和swagger-ui集成到一个Laravel友好的包中。
当您以调试模式运行您的应用程序时，L5-Swagger将扫描您的应用程序文件夹（或任何在包配置中设置在"app-dir"变量下的文件夹），生成swagger json文件，并将它们存放在doc-dir文件夹（默认为/docs）中。然后，这些文件由swagger-ui在api-docs目录下提供服务。

安装

安装简单，只需在您的composer.json中添加"lithiumdev/l5-swagger": "~1.0"，然后运行composer update
您也可以直接输入composer require lithiumdev/l5-swagger:~1.0。

composer安装完成后，注册服务提供程序并发布资源

  • 在app/config/app.php中，在路由提供程序上方添加LithiumDev\Swagger\SwaggerServiceProvider::class,以避免任何通配符路由
  • 运行php artisan vendor:publish --provider="LithiumDev\Swagger\SwaggerServiceProvider"以发布所需的资源。

使用方法

有两个可用的路由，一个用于服务swagger JSON文件，另一个用于显示Swagger-UI

您可以通过运行以下命令手动生成swagger json文件
./vendor/bin/swagger app/ -o storage/docs/api-docs.json

更多信息即将到来...