Yii RESTful API

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

  • 快速原型

  • 自定義對象序列化

  • 響應格式(支持默認JSON和XML)

  • 收集數據格式和驗證錯誤

  • 高效的路由

  • HATEOAS支持

  • 內置支持 OPTION 和 HEAD 動詞

  • 數據緩存和HTTP緩存

  • 認證和授權

  • 速率限制

在動作中顯示如何使用 RESTful API ,我們需要準備一些數據。

準備數據庫


第1步 - 創建一個新的數據庫。數據庫可以通過以下兩種方式進行。

  • 在終端運行 mysql -u root –p

  • 登錄數據後,通過執行 CREATE DATABASE mystudy CHARACTER SET utf8 COLLATE utf8_general_ci; 創建一個新的數據庫;

第2步 - 在 config/db.php 文件中配置數據庫連接。下面的配置可根據自己的實際情況配置。

'yii\\db\\Connection', 'dsn' => 'mysql:host = localhost;dbname = mystudy', 'username' => 'root', 'password' => '', 'charset' => 'utf8', \]; ?>

第3步 - 在項目根文件夾執行:yii migrate/create test_table 。此命令將用於創建管理數據庫數據庫遷移。 migrations文件會出現在項目的根的 migrations 文件夾中。
Yii

第4步 - 修改遷移文件(在本示例中生成的是:m160529_014611_test_table.php),並使用以下這些代碼。

createTable("user", \[ "id" => Schema::TYPE\_PK, "name" => Schema::TYPE\_STRING, "email" => Schema::TYPE\_STRING, \]); $this->batchInsert("user", \["name", "email"\], \[ \["User1", "[email protected]"\], \["User2", "[email protected]"\], \["User3", "[email protected]"\], \["User4", "[email protected]"\], \["User5", "[email protected]"\], \["User6", "[email protected]"\], \["User7", "[email protected]"\], \["User8", "[email protected]"\], \["User9", "[email protected]"\], \["User10", "[email protected]"\], \["User11", "[email protected]"\], \]); } public function down() { //$this->dropTable('user'); } } ?>

上述遷移創建用戶表,它包含了以下這些字段:id, name, 和 email。它還增加了一些演示用戶帳號。

第5步 - 在項目的根目錄內運行: yii migrate  來遷移應用到數據庫。執行結果如下圖所示:

Yii

第6步-現在,我們需要爲user表創建模型。爲了簡便起見,我們將使用GII代碼生成工具。在瀏覽器中打開 url: http://localhost:8080/index.php?r=gii 。
然後,點擊 「Model generator」 下的 「Start」按鈕。 填寫表名(「user」)和模型類(「MyUser」),單擊「Preview」按鈕,最後點擊 「Generate」 按鈕。

Yii

Yii
MyUser 文件憶經生成在 models 目錄。

安裝Postman

Postman 是開發RESTful服務一個使用方便的工具。它提供了用於構建請求一個有用的接口。

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

要安裝它,點擊「Add to Chrome」按鈕。

Yii