README

此包将 Swagger-php 和 swagger-ui 结合为一个 Laravel 适用的包。在您的应用程序以调试模式运行时，Swaggervel 将扫描您的应用程序文件夹（或任何在包配置中“app-dir”变量下设置的文件夹），生成 Swagger JSON 文件并将它们存放到 doc-dir 文件夹中（默认为 /docs）。然后，由 swagger-ui 在 api-docs 目录下提供文件。

安装

在 Laravel 根目录下执行 composer require appointer/swaggervel --dev
将 Appointer\Swaggervel\SwaggervelServiceProvider::class 添加到 app/config/app.php 文件中的 providers 数组中，放在路由提供者之上，以避免任何通配路由
运行 php artisan vendor:publish --tag=public 将 swagger-ui 推送到您的公共文件夹（可在 public/vendor/swaggervel 中找到）。
可选运行 php artisan vendor:publish --tag=config 将 swaggervel 默认配置推送到您的应用程序配置目录。
可选运行 php artisan vendor:publish --tag=views 将 swaggervel 索引视图文件推送到 resources/views/vendor/swaggervel。

示例（使用默认配置时）

www.example.com/docs <- 您可能在那里找到自动生成的 Swagger .json 文件
www.example.com/api/docs <- 访问您的 Swagger UI

选项

所有选项都在 swaggervel.php 配置文件中进行了详细注释。

如何使用 Swagger-php

实际的 Swagger 规范超出了此包的范围。Swaggervel 所做的只是将 swagger-php 和 swagger-ui 打包成 Laravel 适用的形式，并尝试使其易于提供。有关如何使用 swagger-php 的信息，请参阅此处。有关 swagger-php 的良好示例，请参阅此处。

其他说明

此包是 slampenny/Swaggervel 的分支，因为它不再维护。

待办事项

对 /doc 调用的处理仍然非常不一致，因为您无法更改文件名（api-docs.json），但可以更改使用 /doc 路由时访问的文件。

robosys-labs / swaggervel

维护者

详情

README

安装

示例（使用默认配置时）

选项

如何使用 Swagger-php

其他说明

待办事项