https://github.com/ignatenkovnikita/yii2-swagger
Yii Swagger Module Generate API Docs
https://github.com/ignatenkovnikita/yii2-swagger
api api-documentation restful swagger swagger-php swagger-ui swagger3 yii2-modules yii2-swagger
Last synced: about 1 month ago
JSON representation
Yii Swagger Module Generate API Docs
- Host: GitHub
- URL: https://github.com/ignatenkovnikita/yii2-swagger
- Owner: ignatenkovnikita
- License: mit
- Created: 2017-06-30T13:15:25.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-08-01T14:37:13.000Z (almost 3 years ago)
- Last Synced: 2025-03-25T14:44:44.325Z (2 months ago)
- Topics: api, api-documentation, restful, swagger, swagger-php, swagger-ui, swagger3, yii2-modules, yii2-swagger
- Language: PHP
- Homepage: https://ignatenkovnikita.github.io/yii2-swagger/
- Size: 21.5 KB
- Stars: 12
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Yii2 Swagger Module
============
This module integrate [swagger-php](https://github.com/zircote/swagger-php) and [swagger-ui v3](https://github.com/swagger-api/swagger-ui).
[](https://packagist.org/packages/ignatenkovnikita/yii2-swagger)
[](https://packagist.org/packages/ignatenkovnikita/yii2-swagger)
[](https://packagist.org/packages/ignatenkovnikita/yii2-swagger)
[](https://packagist.org/packages/ignatenkovnikita/yii2-swagger)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require ignatenkovnikita/yii2-swagger:dev-master
```
or add
```
"ignatenkovnikita/yii2-swagger": "dev-master"
```
to the require section of your `composer.json` file.
Usage
-----
Once the extension is installed, simply use it in your code by :
You set url, where locate json file OR set path for scan
```php
'modules' => [
...
'swagger' => [
'class' => \ignatenkovnikita\swagger\Module::class,
// 'url' => 'http://petstore.swagger.io/v2/swagger.json',
'path' => '@frontend/modules/api',
// disable page with your logic
'isDisable' => function () {
return false;
},
// replace placeholders in swagger content
'afterRender' => function ($content) {
$content = str_replace('{{host}}', 'http://example.com', $content);
$content = str_replace('{{basePath}}', '/api/v1', $content);
return $content;
}
]
...
],
```
Now you open yourdomain.com/swagger and see API documentation
Example Module
```php
/**
* Class Module Api
*
*
* @SWG\Swagger(
* basePath="{{basePath}}",
* host="{{host}}",
* schemes={"http"},
* @SWG\Info(
* version="1.0",
* title="Example API",
* @SWG\Contact(name="Example", url="http://example.ru"),
* ),
* @SWG\Definition(
* definition="Error",
* required={"code", "message"},
* @SWG\Property(
* property="code",
* type="integer",
* format="int32"
* ),
* @SWG\Property(
* property="message",
* type="string"
* )
* )
* )
*/
```
Example controller
```php
/**
* @SWG\Post(
* path = "/user-device/register",
* tags = {"user-device"},
* operationId = "userDevice",
* summary = "Регистрация устройства",
* description = "Регистрация устройства",
* produces = {"application/json"},
* consumes = {"application/json"},
* @SWG\Parameter(
* in = "body",
* name = "body",
* description = "Тело запроса",
* required = true,
* type = "string",
* @SWG\Schema(ref = "#/definitions/UserDeviceForm")
* ),
* @SWG\Response(response = 200, description = "success")
*)
* @throws HttpException
*/
```
Example form
```php
/**
* @SWG\Definition(
* definition="UserDeviceForm",
* required={"uuid", "token", "os", "json"},
* @SWG\Property(
* property="uuid",
* type="string",
* description="UUID устройства",
* example="e3243"
* ),
* @SWG\Property(
* property="token",
* type="string",
* description="token для Google Fire Base",
* example="e3243"
* ),
* @SWG\Property(
* property="os",
* type="string",
* description="os устройства android|ios",
* example="ios"
* ),
* @SWG\Property(
* property="json",
* type="string",
* description="json достпные параметры устройства, название модели, версия ОС и др",
* example=""
* )
* )
*/
```
### TODO
- add cache
- add customization
## Donate
[](http://paypal.me/ignatenkovnikita)