Как сделать api yii2 basic?

Question

[AlexAll]

Привет, сделал по этой инструкции https://www.diggin-data.de/dd-cms/blog/post/view/i... но при попытке перейти по ссылке site.local/api/v1/project тишина
Что там не так?

Comments

[Дмитрий]

https://elisdn.ru/blog/103/yii2-rest-api

[AlexAll]

Дмитрий, смотрел, я это давно, там про advanced а как на basic сделать негде нечего адекватного не нашел

[Дмитрий]

AlexAll, advanced это расширенный basic, если можно так сказать. В остальном никакой разницы.

[AlexAll]

Дмитрий, да понятно что ни какой, но в адвансед я делал это просто его инструкции создавал новую папку и в codeception.yml прописывал эту папку. а тут хз как делать модулем или отдельной папкой

[Дмитрий]

AlexAll, всё так же. Просто надо взять и немного подумать)))

Answer 1

[Максим]

Ничего сложного Нет! Создаёте модуль api и подключаете его:

'modules' => [
        'api' => [
            'class' => app\modules\api\Module::class,
            'modules' => [
                'v1' => [
                    'class' => app\modules\api\modules\v1\Module::class,
                    'controllerMap' => [
                        'organizations' => \app\modules\organizations\api\controllers\DefaultController::class,
                        'users' => \app\modules\users\api\Controllers\DefaultController::class,
                        'cities' => \app\modules\api\modules\v1\controllers\events\CitiesController::class,
                    ],
                ]
            ],
        ],
    ],

2. Создаёте Контроллер наследуемый от ActiveController

class DefaultController extends ActiveController
{
    public $modelClass = Organization::class;
    public $serializer = [
        'class' => 'yii\rest\Serializer',
        'collectionEnvelope' => 'items',
    ];

    public function behaviors()
    {
        $behaviors = parent::behaviors();
        $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON;
        return $behaviors;
    }

    public function actions()
    {
        $actions = parent::actions();
        unset($actions['delete'], $actions['create'], $actions['view']);
        return $actions;
    }
}

3. Настраиваете роуты например так:

[
                    'class' => 'yii\rest\UrlRule',
                    'controller' => ['api/v1/organizations'],
                    'extraPatterns' => [
                        'GET, POST find' => 'find',
                    ],
                ],

4. В конфигах api примерно такое

'components' => [
        'response' => [
            // ...
            'formatters' => [
                \yii\web\Response::FORMAT_JSON => [
                    'class' => yii\web\JsonResponseFormatter::class,
                    'prettyPrint' => YII_DEBUG, // используем "pretty" в режиме отладки
                    'encodeOptions' => JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE,
                ],
            ],
        ],
        'as contentNegotiator' => [
            'class' => \yii\filters\ContentNegotiator::class,
            'formatParam' => '_format',
            'formats' => [
                'application/json' => \yii\web\Response::FORMAT_JSON,
                'application/octet-stream' => \yii\web\Response::FORMAT_JSON,
                'text/html' => \yii\web\Response::FORMAT_JSON,
                'application/xml' => \yii\web\Response::FORMAT_XML,
            ],
        ],
    ],

Comments

[zepedro]

Максим, а в какой файл, что писать. Ну я понимаю где создавать контроллеры ( в папке контроллеров) роуты надо прописывать web/config, а вот модуль и конфиги api это где должно быть в шаблоне basic?

[Максим]

zepedro, конфиги в конфигах, модули в модулях

[zepedro]

Вот как выглядит дерево каталогов в бейсик версии yii2.

[Максим]

zepedro, и?) Вы думаете я не знаю как выглядит шаблон basic? Если вы не знаете в какой конфиг писать для api, то создайте новый конфиг api.php

[zepedro]

Спасибо, за объяснения, но думаю, что это не то место где стоит искать ответы!
Тот случай, когда человек сам шарит, но объяснять не умеет! (не скрою, что я нуб в фреймворках, но этот yii2 та еще заlупа)

[Максим]

zepedro, да с чего вы так решили. Конфиг сделать другой много знаний не требуется. Создать новую папку или модуль тоже много опыта и знаний не требуется.

1. Создать конфиг
Заходим в папку config. Создаём там api.php
2. Заходим в папку modules и создаём там папку modules/api/ и создаём модуль.