Yii RESTful APIs
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:http://localhost:8080/index.php?r=gii ,然后单击“Model generator”标题下的“Start”按钮。填写表名称(“user”)和模型类(“MyUser”),点击“Preview”按钮,最后点击“Generate”按钮。
MyUser模型应该出现在models目录中。
安装Postman
Postman是开发RESTful服务时一个方便的工具。它提供了一个有用的界面来构建请求。
您可以在以下位置找到这个工具:https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en。
要安装它,请点击“添加到Chrome”按钮。