iamok/yii2-swagger-ui

扩展集成 swagger-ui 和 swagger-php，根据注释自动生成 OpenAPI 文档。

1.0.1 2018-01-05 03:30 UTC

Requires

• bower-asset/swagger-ui: ^3.0.0
• yiisoft/yii2: ^2.0.0
• zircote/swagger-php: ^2.0.0

MIT

• wewelove

• extension
• swagger
• yii2

README

扩展集成 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 版本，扫描目录
        ]
    ],
],

参考

• swagger
• swagger-php