README

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

安装

在 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 所做的只是以 Laravel 友好的方式打包 swagger-php 和 swagger-ui，并尝试使其易于提供。有关如何使用 swagger-php 的信息，请参阅此处。有关 swagger-php 的良好示例，请参阅此处。

进一步说明

由于它不再维护，本包是 slampenny/Swaggervel 的分支。

待办事项

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

maxictbv / swaggervel

维护者

详细信息

README

安装

示例（使用默认配置时）

选项

如何使用 Swagger-php

进一步说明

待办事项