Yii2框架制作RESTful风格的API快速入门教程


Posted in PHP onNovember 08, 2016

先给大家说下什么是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快速入门教程,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!

PHP 相关文章推荐
不用iconv库的gb2312与utf-8的互换函数
Oct 09 PHP
PHPnow安装服务[apache_pn]失败的问题的解决方法
Sep 10 PHP
提示Trying to clone an uncloneable object of class Imagic的解决
Oct 27 PHP
PHP通过插入mysql数据来实现多机互锁实例
Nov 05 PHP
php格式化金额函数分享
Feb 02 PHP
php打印一个边长为N的实心和空心菱型的方法
Mar 02 PHP
迪菲-赫尔曼密钥交换(Diffie?Hellman)算法原理和PHP实现版
May 12 PHP
PHP实现获取中英文首字母
Jun 19 PHP
原生php实现excel文件读写的方法分析
Apr 25 PHP
PHP使用PDO实现mysql防注入功能详解
Dec 20 PHP
PHP扩展类型及安装方式解析
Apr 27 PHP
基于PHP+Mysql简单实现了图书购物车系统的实例详解
Aug 06 PHP
php封装的数据库函数与用法示例【参考thinkPHP】
Nov 08 #PHP
php基于curl重写file_get_contents函数实例
Nov 08 #PHP
php发送http请求的常用方法分析
Nov 08 #PHP
php curl中gzip的压缩性能测试实例分析
Nov 08 #PHP
php执行多个存储过程的方法【基于thinkPHP】
Nov 08 #PHP
php实现的http请求封装示例
Nov 08 #PHP
PHP实现原生态图片上传封装类方法
Nov 08 #PHP
You might like
一个oracle+PHP的查询的例子
2006/10/09 PHP
在线短消息收发的程序,不用数据库
2006/10/09 PHP
php mysql数据库操作类
2008/06/04 PHP
关于PHPDocument 代码注释规范的总结
2013/06/25 PHP
Symfony2学习笔记之系统路由详解
2016/03/17 PHP
centos下file_put_contents()无法写入文件的原因及解决方法
2017/04/01 PHP
Laravel中为什么不使用blpop取队列详析
2018/08/01 PHP
JavaScript语法着色引擎(demo及打包文件下载)
2007/06/13 Javascript
用JavaScript编写COM组件的步骤
2009/03/17 Javascript
js post方式传递提交的实现代码
2010/05/31 Javascript
javaScript使用EL表达式的几种方式
2014/05/27 Javascript
javascript常用函数归纳整理
2014/10/31 Javascript
Ext JS框架中日期函数的用法及日期选择控件的实现
2016/05/21 Javascript
JS提示:Uncaught SyntaxError:Unexpected token ) 错误的解决方法
2016/08/19 Javascript
微信小程序 Page()函数详解
2016/10/17 Javascript
AngularJS过滤器filter用法总结
2016/12/13 Javascript
微信小程序 textarea 组件详解及简单实例
2017/01/10 Javascript
webpack进阶——缓存与独立打包的用法
2017/08/02 Javascript
AngularJS 的$timeout服务示例代码
2017/09/21 Javascript
JavaScript高级函数应用之分时函数实例分析
2018/08/03 Javascript
基于原生JS封装的Modal对话框插件的示例代码
2020/09/09 Javascript
Python爬取Coursera课程资源的详细过程
2014/11/04 Python
python使用Tkinter显示网络图片的方法
2015/04/24 Python
Python 字典与字符串的互转实例
2017/01/13 Python
python队列通信:rabbitMQ的使用(实例讲解)
2017/12/22 Python
Python assert语句的简单使用示例
2019/07/28 Python
python opencv 检测移动物体并截图保存实例
2020/03/10 Python
python函数map()和partial()的知识点总结
2020/05/26 Python
Python爬虫实例——爬取美团美食数据
2020/07/15 Python
使用PyCharm官方中文语言包汉化PyCharm
2020/11/18 Python
html5 canvas绘制放射性渐变色效果
2018/01/04 HTML / CSS
高中美术教学反思
2014/01/19 职场文书
超市活动计划书
2014/04/24 职场文书
我们的节日元宵活动方案
2014/08/23 职场文书
纪念九一八事变演讲稿:牢记九一八,屈辱怎能忘
2014/09/14 职场文书
2015年社会实践个人总结
2015/03/06 职场文书