Yii RESTful API

Yii为实现RESTful API提供了以下有用的功能：

快速原型设计
可定制的对象序列化
响应格式（默认支持JSON和XML）
收集数据和验证错误的格式
高效的路由
支持HATEOAS
内置对OPTIONS和HEAD动词的支持
数据缓存和HTTP缓存
认证和授权
限速

为了展示RESTful APIs，我们需要数据。

准备数据库

第1步 - 创建一个新的数据库。数据库可以通过以下两种方式进行准备。

在终端中运行 mysql -u root -p 。
通过 CREATE DATABASE 创建一个新的数据库 _helloworld CHARACTER SET utf8 COLLATE utf8_generalci;

第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');
      }
   }
?>

上述迁移创建一个包含这些字段的用户表：id，名称和电子邮件。它还增加了一些演示用户。

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

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

模型生成器

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

安装邮差

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

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

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

安装邮差

下一章：Yii 字段

通过重写 fields（）和extraFields（）方法，您可以定义可以将哪些数据放入响应中。这两种方法的区别在于前者定义了默认的字段集合，这些字段应该包含在响应中，而后者定义附加字段，如果最终用户通过扩展查询参数请求 ...

上一章：Yii RESTful API in Action

下一章：Yii 字段