README

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

安装

在 Laravel 根目录下执行 composer require doegel/swaggervel --dev
运行 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 的分支，因为它不再维护。

TODO

处理 /doc 调用的方式仍然非常不一致，因为您不能更改文件名（api-docs.json），但是您能够更改使用 /doc 路由时访问的文件。

doegel / swaggervel

维护者

详细信息

README

安装

示例（使用默认配置时）

选项

如何使用 Swagger-php

其他说明

TODO