huijiewei/yii2-swagger

Swagger 扩展

3.0.2 2019-11-30 03:09 UTC

Requires

• php: ^7.1.3
• npm-asset/swagger-ui-dist: ^3.0
• yiisoft/yii2: ^2.0
• zircote/swagger-php: ^3.0

MIT

• Huijie Wei

README

Yii2 Swagger 扩展

安装

composer require huijiewei/yii2-swagger

用法

Controller 里面集成 Action:

public function actions()
{
    return [
        'ui' => [
            'class' => 'huijiewei\swagger\actions\SwaggerUiAction',
            'apiUrl' => \yii\helpers\Url::to(['/site/api'], true),
        ],
        'api' => [
            'class' => 'huijiewei\swagger\actions\SwaggerApiAction',
            'scanDir' => '扫描的目录，可以是数组，支持 yii 的 alias'，
        ],
    ];
}

Module 里面集成 Controller:

public function init()
{
    parent::init();

    $this->controllerMap = [
        'swagger' => [
            'class' => 'huijiewei\swagger\SwaggerController',
            'apiOptions' => [
                'scanDir' => '扫描的目录，可以是数组，支持 yii 的 alias',
                'defines' => [ // 可以定义一些常量，具体查阅 swagger-php 文档
                    'API_HOST' => 'API_HOST',
                    'API_BASE_PATH' => 'BASE_PATH'
                ]
            ],
            'uiOptions' => [
                'apiUrlRoute' => 'swagger/api'
            ]
        ],
    ];
}

更多文档

查阅 Swagger PHP 文档.

查阅 Swagger UI 文档.

感谢 swagger-php swagger-ui