扩展集成 swagger-ui 和 swagger-php,根据注释自动生成 OpenAPI 文档。
推荐使用 composer 安装:
composer require --prefer-dist iamok/yii2-swagger-ui
修改项目配置文件 ./config/main.php
,添加 docs
项目:
'modules' => [
'v1' => [
'class' => 'app\modules\v1\Module',
],
'v2' => [
'class' => 'app\modules\v2\Module',
],
'docs' => [
'class' => 'iamok\swagger\Module',
'name' => 'App', // 项目名称
'api' => [
'v1' => ['swagger', 'controllers', 'models'], // v1 版本,扫描目录
'v2' => ['swagger', 'controllers', 'models'] // v2 版本,扫描目录
]
],
],