Yii - API RESTful в действии

Класс контроллера расширяется от yii\rest\ActiveControllerкласс, который реализует общие действия RESTful. Мы указываем$modelClass свойство, чтобы контроллер знал, какую модель использовать для управления данными.

Step 1 - Создайте файл с именем UserController.php внутри папки контроллеров.

<?php
   namespace app\controllers;
   use yii\rest\ActiveController;
   class UserController extends ActiveController {
      public $modelClass = 'app\models\MyUser';
   }
?>

Затем нам нужно настроить компонент urlManager, чтобы можно было получить доступ к пользовательским данным и управлять ими с помощью значимых HTTP-глаголов и красивых URL-адресов. Чтобы позволить API получать доступ к данным в JSON, мы должны настроить свойство parsers дляrequest компонент приложения.

Step 2 - Измените config/web.php файл таким образом -

<?php
   $params = require(__DIR__ . '/params.php'); $config = [
      'id' => 'basic',
      'basePath' => dirname(__DIR__),
      'bootstrap' => ['log'],
      'components' => [
         'request' => [
            // !!! insert a secret key in the following (if it is empty) - this is 
               //required by cookie validation
            'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO',
         ],
         'cache' => [
            'class' => 'yii\caching\FileCache',
         ],
         'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
         ],
         'errorHandler' => [
            'errorAction' => 'site/error',
         ],
         'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            // send all mails to a file by default. You have to set
            // 'useFileTransport' to false and configure a transport
            // for the mailer to send real emails.
            'useFileTransport' => true,
         ],
         'log' => [
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
               [
                  'class' => 'yii\log\FileTarget',
                  'levels' => ['error', 'warning'],
               ],
            ],
         ],
         'urlManager' => [
            'enablePrettyUrl' => true,
            'enableStrictParsing' => true,
            'showScriptName' => false,
            'rules' => [
               ['class' => 'yii\rest\UrlRule', 'controller' => 'user'],
            ],
         ],
         'request' => [
            'parsers' => [
               'application/json' => 'yii\web\JsonParser',
            ]
         ],
         'db' => require(__DIR__ . '/db.php'),
      ],
      'modules' => [
         'hello' => [
            'class' => 'app\modules\hello\Hello',
         ],
      ],
      'params' => $params, ]; if (YII_ENV_DEV) { // configuration adjustments for 'dev' environment $config['bootstrap'][] = 'debug';
      $config['modules']['debug'] = [ 'class' => 'yii\debug\Module', ]; $config['bootstrap'][] = 'gii';
      $config['modules']['gii'] = [ 'class' => 'yii\gii\Module', ]; } return $config;
?>

Приложив минимальные усилия, мы только что создали RESTful API для доступа к пользовательским данным. API включают в себя -

  • GET /users - перечислить всех пользователей постранично

  • HEAD /users - показать обзорную информацию о списке пользователей

  • POST /users - создать нового пользователя

  • GET /users/20 - вернуть реквизиты пользователя 20

  • HEAD /users/20 - показать обзорную информацию пользователя 20

  • PATCH /users/ 20 and PUT /users/20 - обновить пользователя 20

  • DELETE /users/20 - удалить пользователя 20

  • OPTIONS /users - показать поддерживаемые глаголы относительно конечной точки / пользователей

  • OPTIONS /users/20 - показать поддерживаемые глаголы относительно конечной точки / пользователей / 20

Обратите внимание, что Yii автоматически ставит имя контроллера во множественное число.

Step 3 - Теперь открой Почтальон, набери http://localhost:8080/users, и нажмите «Отправить». Вы увидите следующее.

Step 4 - Чтобы создать нового пользователя, измените тип запроса на POST, добавьте два параметра тела: имя и адрес электронной почты и нажмите «Отправить».

Step 5 - Вы можете использовать fieldsпараметр, чтобы указать, какие поля должны быть включены в результат. Например, URLhttp://localhost:8080/users?fields=id, имя вернет только id и name поля, как показано на следующем снимке экрана.