Yii RESTful API in Action

控制器类继承自 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的形式访问数据，我们应该配置请求应用程序组件的解析器属性。

第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 /用户 - 显示用户列表的概述信息
POST /用户 - 创建一个新用户
GET / users / 20 - 返回用户20的详细信息
HEAD / users / 20 - 显示用户20的概述信息
PATCH / users / 20和PUT / users / 20 - 更新用户20
DELETE / users / 20 - 删除用户20
选项/用户 - 显示关于端点/用户的支持动词
选项/用户/ 20 - 显示关于端点/用户/ 20的支持动词

注意，Yii自动将控制器名称复数化。

第3步 - 现在，打开邮递员，打入 http：// localhost：8080 / users ，然后点击“发送”。你会看到以下内容。

打开邮差

第4步 - 要创建新用户，请将请求类型更改为POST，添加两个正文参数：名称和电子邮件，然后单击“发送”。

创建新用户

第5步 - 您可以使用 fields 参数来指定哪些字段应该包含在结果中。例如，URL http：// localhost：8080 / users？fields = id ，name将只返回 id 和 name 字段，如以下屏幕截图所示。

使用字段

下一章：Yii RESTful API

Yii为实现RESTful API提供了以下有用的功能：快速原型设计可定制的对象序列化响应格式（默认支持JSON和XML）收集数据和验证错误的格式高效的路由支持HATEOAS内置对OPTIONS和HEAD动词 ...

上一章：Yii 主题

下一章：Yii RESTful API