通过 
搜索
搜索laravel-russian / swaggervel
将 OpenApi/Swagger 集成到 Laravel 的好方法
v2.5
2019-09-09 20:08 UTC
Requires
- php: >=5.6.0
- illuminate/support: ^5.0|^6.0
- swagger-api/swagger-ui: ^3.1
- zircote/swagger-php: ^2.0
README
此软件包将 Swagger-php 和 swagger-ui 合并成一个适用于 Laravel 的软件包。当您以调试模式运行应用程序时，Swaggervel 将扫描您的应用程序文件夹（或任何在 packages 配置中的 "app-dir" 变量下设置的文件夹），生成 swagger json 文件并将它们存放在 doc-dir 文件夹中（默认为 /docs）。然后，文件由 swagger-ui 在 api-docs 目录下提供服务。
安装
- 在 Laravel 根目录下执行
composer require laravel-russian/swaggervel --dev - 将
LaravelRussian\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 路由时访问的文件。