Yii - RESTful API

Yii 提供了以下用於實現 RESTful API 的有用功能：

• 快速原型設計
• 可自定義的物件序列化
• 響應格式（預設支援 JSON 和 XML）
• 集合資料和驗證錯誤的格式化
• 高效路由
• 支援 HATEOAS
• 內建支援 OPTIONS 和 HEAD 方法
• 資料快取和 HTTP 快取
• 身份驗證和授權
• 速率限制

為了展示 RESTful API 的實際應用，我們需要一些資料。

準備資料庫

步驟 1 - 建立一個新的資料庫。可以透過以下兩種方式準備資料庫。

• 在終端執行 mysql -u root –p。

• 透過 CREATE DATABASE helloworld CHARACTER SET utf8 COLLATE utf8_general_ci; 建立一個新的資料庫。

步驟 2 - 在 config/db.php 檔案中配置資料庫連線。以下配置適用於當前使用的系統。

<?php
   return [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host = localhost;dbname = helloworld',
      'username' => 'vladimir',
      'password' => '12345',
      'charset' => 'utf8',
   ];
?>

步驟 3 - 在根資料夾中執行 ./yii migrate/create test_table。此命令將建立一個數據庫遷移來管理我們的資料庫。遷移檔案應該出現在專案根目錄的 migrations 資料夾中。

步驟 4 - 修改遷移檔案（在本例中為 m160106_163154_test_table.php）。

<?php
   use yii\db\Schema;
   
   use yii\db\Migration;
   class m160106_163154_test_table extends Migration {
      public function safeUp() {
         $this->createTable("user", [
            "id" => Schema::TYPE_PK,
            "name" => Schema::TYPE_STRING,
            "email" => Schema::TYPE_STRING,
         ]);
         $this->batchInsert("user", ["name", "email"], [
            ["User1", "user1@gmail.com"],
            ["User2", "user2@gmail.com"],
            ["User3", "user3@gmail.com"],
            ["User4", "user4@gmail.com"],
            ["User5", "user5@gmail.com"], 
            ["User6", "user6@gmail.com"],
            ["User7", "user7@gmail.com"],
            ["User8", "user8@gmail.com"],
            ["User9", "user9@gmail.com"],
            ["User10", "user10@gmail.com"],
            ["User11", "user11@gmail.com"],
         ]);
      }
      public function safeDown() {
         $this->dropTable('user');
      }
   }
?>

以上遷移建立了一個名為 user 的表，包含以下欄位：id、name 和 email。它還添加了一些演示使用者。

步驟 5 - 在專案根目錄中執行 ./yii migrate 將遷移應用到資料庫。

步驟 6 - 現在，我們需要為 user 表建立一個模型。為了簡單起見，我們將使用 Gii 程式碼生成工具。開啟此 url: https://:8080/index.php?r=gii。然後，點選“模型生成器”標題下的“開始”按鈕。填寫表名（“user”）和模型類（“MyUser”），點選“預覽”按鈕，最後點選“生成”按鈕。

MyUser 模型應該出現在 models 目錄中。

安裝 Postman

Postman 是開發 RESTful 服務時一個方便的工具。它提供了一個有用的介面來構建請求。

您可以在 https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en 找到此工具。

要安裝它，請點選“新增到 Chrome”按鈕。