Как искользовать swagger в yii2?

Question

[BloodVIRUS]

Здравствуйте. Для общего образования хочу научиться работать с сваггером.

Есть статьи, в которых описано как с ним работать. И там описано на первый взгляд три простых шага:

1. Composer'ом ставим в проект сваггер
2. С гитхаба сваггера берется папка фронта, и заливается в web/docs
3. Создается контроллер, SwaggerController, в нем единственный экшен, в котором указываются директории для сканирования.

После чего мы запускаем (не важно из консоли, из адресной строки) этот контроллер\действие, оно сканирует директории, и на основе их, на основе разметки для сваггера создают json файл, который в шаге 2 в index.html указывается

И вроде как бы все должно работать. Но блин, код контроллера для геренации json не работает, хотя в разных источниках он один и тот же.

Один из знакомых вообще говорит что генерировать json файл не нужно. Все генерируется на лету, но такого даже примерно нагуглить не могу.. Помогите пожалуйста, вторые сутки пытаюсь разобраться, но ничего не получается. Может не туда смотрю?

Comments

[Denis]

вроди все верно описал, в моем случае
..../swagger/doc - сама спецификация
.../swagger/get-json - автоматически генерируется json - собственно этот урл и подставляется в поле на странице спецификации

[BloodVIRUS]

Denis, а можете поделиться кодом? То что я нахожу - не хочет работать. Но там и код написан 2 и более лет назад..

[Denis]

class SwaggerController extends Controller
{
    public function actions()
    {
        return [
            //The document preview addesss:http://api.yourhost.com/site/doc
            'doc' => [
                'class' => 'light\swagger\SwaggerAction',
                'restUrl' => \yii\helpers\Url::to(['/swagger/get-json'], 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',
            ],
        ];
    }

    /**
     * @inheritdoc
     */
    public $layout = 'swagger';

    /**
     * Displays homepage.
     *
     * @return mixed
     */
    public function actionIndex()
    {
        return $this->render('index');
    }

    /**
     * JSON for swagger
     * @return string
     */
    public function actionGetJson()
    {
        $swagger = \Swagger\scan(Yii::$app->basePath . '/../api/modules');
        header('Content-Type: application/json');
        echo $swagger;
    }

}

Не уверен что все это нужно но примерно как то так