README

Swagger Documentation Generator for Yii2 Framework

Swagger/OpenAPI Documentation Generator for Yii2 Framework.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist breadhead/yii2-swagger "*"

or add

"breadhead/yii2-swagger": "*"

to the require section of your composer.json.

Configuration

You need to configure two actions as follows:

<?php

namespace app\controllers;

use Yii;
use yii\helpers\Url;
use yii\web\Controller;

/**
 * 
 * @SWG\Info(version="1.0", title="Simple API")
 */
class SiteController extends Controller
{
    /**
     * @inheritdoc
     */
    public function actions(): array
    {
        return [
            'docs' => [
                'class' => 'breadhead\swagger\SwaggerUIRenderer',
                'restUrl' => Url::to(['site/json-schema']),
            ],
            'json-schema' => [
                'class' => 'breadhead\swagger\OpenAPIRenderer',
                // Тhe list of directories that contains the swagger annotations.
                'scanDir' => [
                    Yii::getAlias('@app/controllers'),
                    Yii::getAlias('@app/models'),
                ],
            ],
            'error' => [
                'class' => 'yii\web\ErrorAction',
            ],
        ];
    }
}

Usage

1. Creating a Controller

First, create a controller class app\controllers\UserController as follows:

namespace app\controllers;

use app\models\User;
use yii\data\ActiveDataProvider;
use yii\rest\Controller;

/**
 * Class UserController
 */
class UserController extends Controller
{
    /**
     * @OA\Get(path="/user",
     *     tags={"User"},
     *     summary="Retrieves the collection of User resources.",
     *     @OA\Response(
     *         response = 200,
     *         description = "User collection response",
     *         @OA\Schema(ref = "#/components/schemas/User")
     *     ),
     * )
     */
    public function actionIndex()
    {
        $dataProvider = new ActiveDataProvider([
            'query' => User::find(),
        ]);

        return $dataProvider;
    }
}

1. Creating User definition

You need to create folder app/models/definitions and add User definition class as follows:

<?php

namespace app\models\definitions;

/**
 * @OA\SCHEMA(required={"username", "email"})
 *
 * @OA\Property(property="id", type="integer")
 * @OA\Property(property="email", type="string")
 * @OA\Property(property="username", type="string")
 */
class User
{
}

1. Configuring URL Rules

Then, modify the configuration of the urlManager component in your application configuration:

'urlManager' => [
    'enablePrettyUrl' => true,
    'enableStrictParsing' => true,
    'showScriptName' => false,
    'rules' => [
        'GET,HEAD users' => 'user/index',
    ],
]

1. Enabling JSON Input

To let the API accept input data in JSON format, configure the parsers property of the request application component to use the yii\web\JsonParser for JSON input:

'request' => [
    'parsers' => [
        'application/json' => 'yii\web\JsonParser',
    ]
]

Trying it Out

Now you can access to swagger documentation section through the following URL:

http://localhost/path/to/index.php?r=site/docs

View in the browser