yarcode/yii2-swagger

Swagger intergation with Yii2

0.1 2016-12-05 08:55 UTC

Requires

• bower-asset/swagger-ui: ~2.1
• symfony/yaml: ~3.0
• yiisoft/yii2: ~2.0

MIT

• restful
• extension
• document
• swagger
• yii2

README

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yarcode/yii2-swagger

or add

"yarcode/yii2-swagger": "*"

Usage

TODO: It should be described in detail.

public function init()
{
    $this->controllerMap = [
        'swagger' => [
            'class' => 'YarCode\Yii2\Swagger\SwaggerController',
            'host' => 'http://some.host',
            'basePath' => '/base/path/to/swagger/doc',,
            'templateFile' => '/@api/path/to/swagger/template.yaml',
            'includePaths' => [
                '/include/path/first',
                '/include/path/second',
            ],
        ]
    ];
    parent::init();
}

License

Copyright (c) 2016 lichunqiang, YarCode