通过 
搜索
搜索kakuilan / swaggervel
将 Swagger 集成到 Laravel 的绝佳方式
0.0.3
2023-06-08 01:05 UTC
Requires
- php: >=5.6.0
- illuminate/support: ^5.0|^6.0|^7.0|^8.0|^9.0
- kakuilan/php-helper: ^0.4.8
- swagger-api/swagger-ui: ^3.1
- zircote/swagger-php: ^2.0
README
appointer/swaggervel 备份
安装
- 在 Laravel 根目录下执行
composer require kakuilan/swaggervel:dev-main - 将
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 的良好示例，请查看此处。