通过以下方式搜索：
tayeb-ali / swaggervel
将Swagger集成到Laravel的绝佳方式
v3.0.1
2022-01-08 10:47 UTC
Requires
- php: >=5.6.0
- swagger-api/swagger-ui: ^3.1
- zircote/swagger-php: ^2.0
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 数组，在 route provider 之上，以避免任何通配符路由 - 运行
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 路由时访问的文件。