Работа с RESTful. Позволяет любой класс использовать в качестве action.
Хорошо использовать с генератором конфигурации на основе аннотаций yii2-generator
Предпочтительный способ установки этого расширения - через composer.
Запустите команду
php composer require --prefer-dist grigor/yii2-rest "1.0.1"
или добавьте в composer.json
"grigor/yii2-rest": "^1.0.1",
Скопируйте папку frontend или backend в корень проекта и переименуйте как вам нравится, у меня будет api. И не забудьте добавить в файл common/config/bootstrap.php такую строчку Yii::setAlias('@api', dirname(dirname(DIR)) . '/api');
Файл common/config/params.php может быть таким:
<?php
return [
...
/**
* Это пути где будут лежать настройки правил для рест апи и настройки методов которые будут отрабатывать в место actions.
*
* Если использовать yii2-generator, то лучше пути сразу писать без @alias или конвертировать
* в относительный|реальный путь. Ниже будет описано почему или см. yii2-generator
* grigor\generator\tools\DeveloperTool::beforeAppRunScanDevDirectories($config);.
*/
'serviceDirectoryPath' => Yii::getAlias('@api/data/static/services'),// тут будут лежать настройки методов.
'rulesPath' => Yii::getAlias('@api/data/static/rules.php'), // тут сами правила со ссылками на настройки выше.
/**
* Параметр говорит генератору в каких папках ведется разработка ядра для апи, в общем случае где искать php файлы
* с аннотациями содержащими настройки для апи.
* Этот параметр использует только yii2-generator, но он использует и параметры выше.
*/
'devDirectories' => [
Yii::getAlias('@api'),
]
...
];Файл console/config/main.php может быть таким:
...
'bootstrap' => ['log', grigor\generator\GeneratorBootstrap::class],
'modules' => [
'generator' => [
'class' => grigor\generator\Module::class,
],
],
...Файл api/config/main.php может быть таким:
<?php
$params = array_merge(
require __DIR__ . '/../../common/config/params.php',
require __DIR__ . '/../../common/config/params-local.php',
require __DIR__ . '/params.php',
require __DIR__ . '/params-local.php'
);
return [
'id' => 'app-api',
'basePath' => dirname(__DIR__),
'bootstrap' => [
'log',
grigor\rest\RestBootstrap::class,
[
'class' => 'yii\filters\ContentNegotiator',
'formats' => [
'application/json' => 'json',
'application/xml' => 'xml',
],
],
],
'modules' => [
'rest' => [
'class' => grigor\rest\Module::class,
],
],
'controllerNamespace' => 'api\controllers',
'components' => [
'request' => [
'parsers' => [
'application/json' => 'yii\web\JsonParser',
],
'enableCsrfCookie' => false
],
'response' => [
'formatters' => [
'json' => [
'class' => 'yii\web\JsonResponseFormatter',
'prettyPrint' => YII_DEBUG,
'encodeOptions' => JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE,
],
],
],
'user' => [
'identityClass' => 'common\models\User',
'enableAutoLogin' => false,
'enableSession' => false,
],
'log' => [
'traceLevel' => YII_DEBUG ? 3 : 0,
'targets' => [
[
'class' => 'yii\log\FileTarget',
'levels' => ['error', 'warning'],
],
],
],
'serviceInstaller' => [
'class' => grigor\rest\urls\installer\ServiceInstaller::class,
'whiteList' => false,
],
'serviceMetaDataReader' => [
'class' => grigor\rest\urls\installer\PhpServiceMetaDataReader::class,
'serviceDirectoryPath' => $params['serviceDirectoryPath'],//берется из common/config/params.php
'rulesPath' => $params['rulesPath'],//берется из common/config/params.php
],
'urlManager' => [
'class' => grigor\rest\urls\UrlManager::class,
'enablePrettyUrl' => true,
'enableStrictParsing' => true,
'showScriptName' => false,
'rules' => [
'GET ' => 'site/index',
'GET v1/shop' => 'site/index',
],
],
],
'params' => $params,
];Параметр
'rulesPath' => $params['rulesPath'], указывает на файл правил для роутов, он примерно выглядит так:
<?php
return [
0 => [
'pattern' => "v1/shop/products/<id:[\w\-]+>", // url по правилам Yii2 за исключением <controller...> (потом будет кидать исключение на такую настройку)
'verb' => ['GET'], //метод по которому сее деяние будет доступно
'alias' => 'product/index', // т.к. контроллеров при таком подходе нет, а для генерации url требуется роут, то прописываем любой не существующий
'class' => 'grigor\rest\urls\ServiceRule', //правило (наследник UrlRule)
'identityService' => 'eca98246-8562-4edb-8d5d-07c65558d9da' //идентификатор настройки для данного роута
],
... и еще куча правил
];Параметр
'serviceDirectoryPath' => $params['serviceDirectoryPath'], - указывает на папку где лежат настройки action (ими могут быть любые классы) Настройки могут находится и в базе и файлах, зависит от реализации ServiceMetaDataReaderInterface Пример настройки (одна настройка один файл) , если планируется хранить в файла то название может быть таким eca98246-8562-4edb-8d5d-07c65558d9da.php да вообще любым
<?php
return [
/** могут использоваться для формирования белых списков уникальных для конкретно этого action */
// 'permissions' => ["guest", "ruleName1", "ruleName2"],
'service' => [
'class' => 'api\project\SomeClass', //экземпляр класса который будет отрабатывать
'method' => 'func' //метод который будет отрабатывать
],
'serializer' => 'api\serialize\SerializeProduct',
'context' => 'api\context\FindModel', // ограничитель области действия - можно так сказать, (типа как findModel)
/** если action предполагает просто какое то действие и после выполнения должен вернуть какой нибудь статус. */
// 'response' => 201,
];Параметр (не обязательный) - 'serializer' => 'api\serialize\SerializeProduct',
если не хочется заморачиваться с fields() и extraFields() можно использовать свой сериалайзер. Он должен иметь один метод обязательный __invoke(...); таким образом можно сериализовать как одну сущность, так и весь DataProviderInterface
public function __invoke(Product $product): array
{
return [
'id' => $product->id,
'name' => $product->name,
];
}Параметр (не обязательный) - 'context' => 'api\context\FindModel', ограничитель условно может быть таким:
class FindModel implements ActionContextInterface
{
public function getParams($args): ?array
{
$id = $args['key'];
if ($id !== '...') {
throw new NotFoundHttpException('Page not found.');
}
return ['id' => $id];
}
}Вернуть он может массив с недостающими в отрабатывающем методе параметрами. Например у нас есть метод public function getProfile(string $id) а api-шка должна отдавать профиль текущего юзера. Т.е. для пользователя системы нет параметра id получается url примерно такой /v2/user/profile метод GET и все, но мы используем public function getProfile(string $id) где нужно передать id user-а в данном случае текущего.
class FindModel implements ActionContextInterface
{
public function getParams($args): ?array
{
return ['id' => \Yii::$app->user->id];// id тут сопоставится с параметром метода getProfile(string $id), потому называться должен также
//причем, если в url будет добавлен параметр id как то так /v2/user/profile/какойтоid (404) или /v2/user/profile?id=какойтоid (проигнорирован) - он будет проигнорирован
}
}Для всего этого дела удачно подходят сервисы и репозитории. Система может использовать аннотации в качестве заместителей файлов конфигураций, если используется yii2-generator. На основе аннотаций генерируются настройки и правила, и записываться либо в файлы, либо в базу (реализуйте интерфейс ServiceMetaDataReaderInterface чтобы он получал настройки из базы для этого дела), это кому как нравится, в последнем случае можно легко организовать админку управления своим апи. Эти системы разделены потому, что в большинстве случаев yii2-generator на проде не нужен, но весьма удобен когда система разрабатывается и его отсутствие не влияет на работоспособность приложения.
Как пользоваться yii2-generator-ом почитайте на его странице
В папке example вы найдете примеры файлов в zip-архиве. Не забывайте про namespace-ы они у вас могут быть другими.
composer tests