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", "[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 safeDown() {
         $this->dropTable('user');
      }
   }
?>

以上迁移创建了一个名为 user 的表，包含以下字段：id、name 和 email。它还添加了一些演示用户。

步骤 5 - 在项目根目录中运行 ./yii migrate 将迁移应用到数据库。

步骤 6 - 现在，我们需要为 user 表创建一个模型。为了简单起见，我们将使用 Gii 代码生成工具。打开此 url: https://127.0.0.1:8080/index.php?r=gii。然后，点击“模型生成器”标题下的“开始”按钮。填写表名（“user”）和模型类（“MyUser”），点击“预览”按钮，最后点击“生成”按钮。

MyUser 模型应该出现在 models 目录中。

安装 Postman

Postman 是开发 RESTful 服务时一个方便的工具。它提供了一个有用的界面来构建请求。

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

要安装它，请点击“添加到 Chrome”按钮。