gbksoft/yii2-swagger

Swagger的Yii 2包装器

维护者

详细信息

github.com/gbksoft/yii2-swagger

源代码

问题

安装次数: 7,575

依赖项: 0

建议者: 0

安全性: 0

星标: 6

关注者: 7

分支: 3

公开问题: 2

语言：JavaScript

类型：yii2-extension

1.2.0 2017-11-08 13:02 UTC

Requires

Requires (Dev)

MIT 9d7e061ef3275582bcc5ee541686ae4a836891fd

moduleextensionswaggeryii2

This package is not auto-updated.

Last update: 2024-09-17 03:03:57 UTC

README

安装

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

运行以下命令之一：

php composer.phar require gbksoft/yii2-swagger

或

"gbksoft/yii2-swagger": "~1.0.0"

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

使用方法

...
    'modules' => [
        'swagger' => [
            'class' => 'gbksoft\modules\swagger\Module',
            'swaggerUrl' => '/api/web/swagger/swagger.json',
            'swaggerPath' => __DIR__ . '/../../api/web/swagger/swagger.json',
            'on beforeJson' => function($event) {
                // Replace response content (swagger.json)
                $event->responseText = mb_ereg_replace('{{http_host}}', \Yii::$app->request->hostInfo, $event->responseText);
                $event->responseText = mb_ereg_replace('{{apiversion}}', \Yii::$app->params['apiversion'], $event->responseText);
            },
        ],
    ],
...

模块URL规则

swagger/                <== Main swagger page
swagger/default/json    <== Get swagger.json file with replacements
swagger/default/history <== Get git logs history (included in bottom on main swagger page)