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。该命令将创建一个数据库迁移来管理我们的数据库。迁移文件应该出现在项目根目录的迁移文件夹中。

第 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、name 和 email。它还添加了一些演示用户。

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

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

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

安装 Postman

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

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

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