通过 
搜索
搜索wolfpack-it / yii2-swagger
为 Yii2 框架提供的 Swagger 扩展。
v1.0.0
2020-04-22 07:31 UTC
Requires
- php: >=7.1.0
- light/yii2-swagger: ^3.0.1
- yiisoft/yii2: ~2.0.19
This package is auto-updated.
Last update: 2024-09-22 18:02:53 UTC
README
本扩展为 Yii2 框架提供 Swagger 动作。
它是 light/yii2-swagger 的扩展。
安装
安装此扩展的首选方式是通过 composer。
运行以下命令
$ composer require wolfpack-it/yii2-swagger
或者
"wolfpack-it/yii2-swagger": "^<latest version>"
将以下内容添加到您的 composer.json 文件的 require 部分。
如果需要 Swagger PHP 版本 3 或更高版本，则还必须安装
"zircote/swagger-php": "<latest version> as 2.0.0",
用法
通过在需要它的应用程序中扩展 \WolfpackIT\swagger\controllers\SwaggerController 来使用此包。通过覆盖 init 函数来设置扫描目录
public function init() { $this->scanDirs = [ \Yii::getAlias('@api/models'), \Yii::getAlias('@api/controllers'), ]; parent::init; }
您需要添加以下内容到应用程序参数中
'swagger' => [ 'oAuthConfiguration' => [ 'baseUrl' => 'https://example.com/oauth/', // must end with a / (forward slash) 'securityScheme' => 'exampleSecurity', // will be used to auto login 'username' => 'info@example.nl', // will be used to auto login 'password' => 'example', // will be used to auto login 'clientId' => 'example-client', // will be used to auto login 'clientSecret' => 'example', // will be used to auto login ] ]
建议只在应用程序不在生产环境中时使用自动登录功能！
如果您需要更细粒度的控制，请查看 \WolfpackIT\swagger\controllers\SwaggerController 中动作的配置。
其余的文档可以在 light/yii2-swagger 中找到。
鸣谢
许可证
MIT 许可证（MIT）。有关更多信息，请参阅 LICENSE。