通过 
搜索
搜索pronabsen / swaggervel
将 Swagger 集成到 Laravel 中的绝佳方法
1.0
2022-07-10 22:48 UTC
Requires
- php: ^7.1|^8.0
- illuminate/support: ^8.83.10
- swagger-api/swagger-ui: ^4.12
- 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 数组中，位于路由提供者之上，以避免任何通配符路由 - 运行
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 的分支。
TODO
- 对 /doc 调用的处理仍然非常不一致，因为您不能更改文件名（api-docs.json），但是可以更改使用 /doc 路由时访问的文件。