Yii - 实战RESTful APIs

控制器类继承自yii\rest\ActiveController类，该类实现了常见的RESTful操作。我们指定$modelClass属性，以便控制器知道使用哪个模型来操作数据。

步骤1 - 在controllers文件夹内创建一个名为UserController.php的文件。

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

接下来，我们需要设置urlManager组件，以便可以使用有意义的HTTP动词和漂亮的URL访问和操作用户数据。为了让API以JSON格式访问数据，我们应该配置request应用组件的parsers属性。

步骤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 和 PUT /users/20 - 更新用户20

• DELETE /users/20 - 删除用户20

• OPTIONS /users - 显示关于端点/users的支持的动词

• OPTIONS /users/20 - 显示关于端点/users/20的支持的动词

注意，Yii会自动将控制器名称转换为复数形式。

步骤3 - 现在，打开Postman，输入https://127.0.0.1:8080/users，然后点击“发送”。您将看到以下内容。

步骤4 - 要创建一个新用户，请将请求类型更改为POST，添加两个主体参数：name和email，然后点击“发送”。

步骤5 - 您可以使用fields参数指定结果中应包含哪些字段。例如，URL https://127.0.0.1:8080/users?fields=id,name 只会返回id和name字段，如下图所示。