yii2-swagger's Introduction

Swagger Module for Yii 2

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require gbksoft/yii2-swagger

or add

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

to the require section of your composer.json file.

Usage

...
    '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);
            },
        ],
    ],
...

Module url rules

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)

yii2-swagger's People

Contributors

Stargazers

Watchers

yii2-swagger's Issues

Can't read swagger JSON from http://localhost/connect/swagger/default/json

exception 'yii\web\NotFoundHttpException' in D:\xampp\htdocs\connect\vendor\gbksoft\yii2-swagger\controllers\DefaultController.php:154 Stack trace: #0 [internal function]: gbksoft\modules\swagger\controllers\DefaultController->actionJson() #1 D:\xampp\htdocs\connect\vendor\yiisoft\yii2\base\InlineAction.php(57): call_user_func_array(Array, Array) #2 D:\xampp\htdocs\connect\vendor\yiisoft\yii2\base\Controller.php(156): yii\base\InlineAction->runWithParams(Array) #3 D:\xampp\htdocs\connect\vendor\yiisoft\yii2\base\Module.php(523): yii\base\Controller->runAction('json', Array) #4 D:\xampp\htdocs\connect\vendor\yiisoft\yii2\web\Application.php(102): yii\base\Module->runAction('swagger/default...', Array) #5 D:\xampp\htdocs\connect\vendor\yiisoft\yii2\base\Application.php(380): yii\web\Application->handleRequest(Object(yii\web\Request)) #6 D:\xampp\htdocs\connect\index.php(12): yii\base\Application->run() #7 {main}