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://:8080/users，然後點選“傳送”。您將看到以下內容。

步驟4 - 要建立一個新使用者，請將請求型別更改為POST，新增兩個主體引數：name和email，然後點選“傳送”。

步驟5 - 您可以使用fields引數指定結果中應包含哪些欄位。例如，URL https://:8080/users?fields=id,name 只會返回id和name欄位，如下圖所示。