2017 © Pedro Peláez
 

library yii2-swagger

swagger intergation with yii2

image

delpfine/yii2-swagger

swagger intergation with yii2

  • Monday, March 27, 2017
  • by delpfine
  • Repository
  • 1 Watchers
  • 0 Stars
  • 13 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 30 Forks
  • 0 Open issues
  • 11 Versions
  • 0 % Grown

The README.md

yii2-swagger

version Download Issues, (*1)

swagger-php intergation with yii2., (*2)

Integration swagger-ui with swagger-php., (*3)

Installation

The preferred way to install this extension is through composer., (*4)

Either run, (*5)

php composer.phar require --prefer-dist light/yii2-swagger "~1.0.4" --dev

or add, (*6)

"light/yii2-swagger": "~1.0.4"

to the require section of your composer.json file., (*7)

Usage

Configure two action as below:, (*8)

public function actions()
{
    return [
        //The document preview addesss:http://api.yourhost.com/site/doc
        'doc' => [
            'class' => 'light\swagger\SwaggerAction',
            'restUrl' => \yii\helpers\Url::to(['/site/api'], true),
        ],
        //The resultUrl action.
        'api' => [
            'class' => 'light\swagger\SwaggerApiAction',
            //The scan directories, you should use real path there.
            'scanDir' => [
                Yii::getAlias('@api/modules/v1/swagger'),
                Yii::getAlias('@api/modules/v1/controllers'),
                Yii::getAlias('@api/modules/v1/models'),
                Yii::getAlias('@api/models'),
            ],
            //The security key
            'api_key' => 'balbalbal',
        ],
    ];
}

For security, you can config api key for protection., (*9)

Caching

public function actions()
{
    return [
        // ...
        'api' => [
            // ...
            'cache' => 'cache',
            'cacheKey' => 'api-swagger-cache', // default is 'api-swagger-cache'
        ],
    ];
}

Clear cache

Access clear cache url YOUR_API_URL?clear-cache or YOUR_API_URL?api_key=YOUR_API_KEY&clear-cache, (*10)

Example: curl 'http://localhost/v1/swagger/api?clear-cache', (*11)

you will see: Succeed clear swagger api cache., (*12)

Finally

If there also some confused, you can refer the Demo., (*13)

License

MIT, (*14)

The Versions

27/03 2017

dev-master

9999999-dev

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

by lichunqiang

extension yii2 swagger restful document

03/03 2017

1.0.4

1.0.4.0

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

by lichunqiang

extension yii2 swagger restful document

02/03 2017

1.0.3

1.0.3.0

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

by lichunqiang

extension yii2 swagger restful document

18/07 2016

1.0.2

1.0.2.0

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by lichunqiang

extension yii2 swagger restful document

19/04 2016

1.0.1

1.0.1.0

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by lichunqiang

extension yii2 swagger restful document

10/01 2016

1.0.0

1.0.0.0

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by lichunqiang

extension yii2 swagger restful document

10/12 2015

0.2.3

0.2.3.0

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by lichunqiang

extension yii2 swagger restful document

08/12 2015

0.2.2

0.2.2.0

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by lichunqiang

extension yii2 swagger restful document

07/12 2015

0.2.1

0.2.1.0

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by lichunqiang

extension yii2 swagger restful document

07/12 2015

0.2.0

0.2.0.0

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by lichunqiang

extension yii2 swagger restful document

07/12 2015

0.1.0

0.1.0.0

swagger intergation with yii2

  Sources   Download

MIT

The Requires

 

The Development Requires

by lichunqiang

extension yii2 swagger restful document