README

Yii2 生成 Swagger 注释

此扩展提供了一个基于 Web 的代码生成器，称为 Gii，用于 Yii 框架 2.0 应用程序。您可以使用 Gii 快速生成 swagger 2.0(openapi 2.0) 注释。

有关许可信息，请查看 LICENSE 文件。

安装

安装此扩展的首选方式是通过 composer。

运行以下命令之一：

composer require lengbin/yii-gii-swagger

或

"lengbin/yii-gii-swagger": *

将以下内容添加到您的 composer.json 文件的 require-dev 部分。

用法

扩展安装后，只需修改您的应用程序配置文件 application\config\main_local.php，如下所示：

    $config['bootstrap'][] = 'gii';
    $config['modules']['gii'] = [
        'class'      => 'yii\gii\Module',
        'generators' => [
            'swagger' => [
                'class'      => 'lengbin\gii\swagger\Generator', //class
                'parameters' => [],                              //set default request parameters
                'responses'  => [                               //set default respons parameters
                    'responseStatus'      => [200, 'default'],
                    'responseDescription' => ['success', '请求失败， http status 强行转为200, 通过code判断'],
                    'ref'                 => ['SuccessDefault', 'ErrorDefault'],
                ],
            ],
            //...
        ],
    ];
    //...

您可以通过以下 URL 访问 Gii：

https:///path/to/index.php?r=gii

或者如果您已启用美观的 URL，您可以使用以下 URL：

https:///path/to/index.php/gii

扩展

您可以使用 Swagger 文档扩展 yii-swagger。

截图

整个页面自定义参数生成 swagger 2.0(openapi 2.0) 注释

lengbin / yii-gii-swagger

维护者

详细信息

README

Yii2 生成 Swagger 注释

安装

用法

扩展

截图