PHPackages                             gbksoft/yii2-swagger - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. gbksoft/yii2-swagger

ActiveYii2-extension[API Development](/categories/api)

gbksoft/yii2-swagger
====================

Yii 2 wrapper for Swagger

1.2.0(8y ago)67.6k3[2 issues](https://github.com/gbksoft/yii2-swagger/issues)MITJavaScript

Since Feb 3Pushed 8y ago6 watchersCompare

[ Source](https://github.com/gbksoft/yii2-swagger)[ Packagist](https://packagist.org/packages/gbksoft/yii2-swagger)[ RSS](/packages/gbksoft-yii2-swagger/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (1)Dependencies (2)Versions (8)Used By (0)

Swagger Module for Yii 2
========================

[](#swagger-module-for-yii-2)

Installation
------------

[](#installation)

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

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
-----

[](#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
----------------

[](#module-url-rules)

```
swagger/