Yii2框架制作RESTful风格的API快速入门教程
先给大家说下什么是rest
restful
rest全称是representational state transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年roy fielding的博士论文中，roy fielding是http规范的主要编写者之一。 他在论文中提到："我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。rest指的是一组架构约束条件和原则。" 如果一个架构符合rest的约束条件和原则，我们就称它为restful架构。
rest本身并没有创造新的技术、组件或服务，而隐藏在restful背后的理念就是使用web的现有特征和能力， 更好地使用现有web标准中的一些准则和约束。虽然rest本身受web技术的影响很深， 但是理论上rest架构风格并不是绑定在http上，只不过目前http是唯一与rest相关的实例。 所以我们这里描述的rest也是通过http实现的rest。
前不久做一个项目，是用yii2框架写一套restful风格的api，就去查了下《yii 2.0 权威指南 》，发现上面写得比较简略。所以就在这里写一篇教程贴，希望帮助刚接触yii2框架restful的小伙伴快速入门。
一、目录结构
实现一个简单地restful api只需用到三个文件。目录如下：
frontend ├─ config │ └ main.php ├─ controllers │ └ bookcontroller.php └─ models └ book.php
二、配置url规则
1.修改服务器的rewrite规则，将所有url全部指向index.php上，使其支持 /books/1 格式。
如果是apache服务器，在frontend/web/ 目录中新建.htaccess文件。文件内容如下：
rewriteengine on
# if a directory or a file exists, use the request directly
rewritecond %{request_filename} !-f
rewritecond %{request_filename} !-d
# otherwise forward the request to index.php
rewriterule . index.php
如果是nginx服务器，修改nginx/conf/nginx.conf，在当前"server{}"的"location / {}"中添加下面红色标记内容：
location / {
try_files $uri $uri/ /index.php$is_args$args;
}
2.修改frontend/config/main.php文件，为book控制器增加一个 url 规则。这样，就能通过美化的 url 和有意义的 http 动词进行访问和操作数据。配置如下：
'components' => [ 'urlmanager' => [ 'enableprettyurl' => true, 'enablestrictparsing' => true, 'showscriptname' => false, 'rules' => [ ['class' => 'yii\rest\urlrule', 'controller' => 'book'], ], ], ],
三、创建一个model
1.在数据库中创建一张book表。book表的内容如下：
-- ----------------------------
-- table structure for book
-- ----------------------------
drop table if exists `book`;
create table `book` (
`id` int(10) unsigned not null auto_increment,
`name` char(50) not null default '',
`num` tinyint(3) unsigned not null default '0',
primary key (`id`)
) engine=innodb auto_increment=6 default charset=utf8;
-- ----------------------------
-- records of book
-- ----------------------------
insert into `book` values ('1', 'toefl', '10');
insert into `book` values ('2', 'ielts', '20');
insert into `book` values ('3', 'sat', '30');
insert into `book` values ('4', 'gre', '40');
insert into `book` values ('5', 'gmat', '50');
2.在frontend/models/目录中新建book.php。文件内容如下：
namespace frontend\models;
use yii\db\activerecord;
class book extends activerecord
{
public static function tablename()
{
return 'book';
}
}
四、创建一个控制器
在frontend/controllers/目录中新建bookcontroller.php。控制器类扩展自 yii\rest\activecontroller。通过指定 yii\rest\activecontroller::modelclass 作为 frontend\models\book， 控制器就能知道使用哪个模型去获取和处理数据。文件内容如下：
namespace frontend\controllers;
use yii\rest\activecontroller;
class bookcontroller extends activecontroller
{
public $modelclass = 'frontend\models\book';
}
五、测试
到这里，我们就已经完成了创建用于访问用户数据 的 restful 风格的 api。创建的 api 包括：
get /books: 列出所有的书
head /books: 显示书的列表的概要信息
post /books: 新增1本书
get /books/1: 返回 书id=1的详细信息
head /books/1: 显示 书id=1的概述信息
patch /books/1 and put /books/1: 更新书id=1的信息
delete /books/1: 删除书id=1的信息
options /books: 显示关于末端 /books 支持的动词
options /books/1: 显示有关末端 /books/1 支持的动词
可以通过web浏览器中输入 url http://{frontend的域名}/books 来访问api，或者使用一些浏览器插件来发送特定的 headers 请求，比如firefox的restclient、chrome的advanced rest client、postman等。
六、说明
1.yii 将在末端使用的控制器的名称自动变为复数。这是因为 yii\rest\urlrule 能够为他们使用的末端全自动复数化控制器。可以通过设置yii\rest\urlrule::pluralize为false来禁用此行为:
'rules' => [ ['class' => 'yii\rest\urlrule', 'controller' => 'book', 'pluralize' => false], ],
2.可以使用fields和expand参数指定哪些字段应该包含在结果内。例如：url http://{frontend的域名}/books?fields=name,num 将只返回 name 和 num 字段。
以上所述是小编给大家介绍的yii2框架制作restful风格的api快速入门教程，希望对大家有所帮助