PHP编写RESTful接口


Posted in PHP onFebruary 23, 2016

首先我们来认识下RESTful

Restful是一种设计风格而不是标准,比如一个接口原本是这样的: http://www.test.com/user/view/id/1

表示获取id为1的用户信息,如果使用Restful风格,可以变成这样:

http://www.test.com/user/1

可以很明显的看出这样做的好处:

1、更简洁的URL,对程序员友好

2、不暴露内部代码结构,更安全

那么,如何实现这个接口呢?首先,我们需要接收到/user/1部分。

$path = $_SERVER['PATH_INFO']; 
$arr = explode('/',$path); 
print_r($arr);

得到下面的结果:

Array ( [0] => [1] => User [2] => 1 )

获取到了参数,下面的操作就很简单了:

if($arr[1] == 'user'){ 
$model = new UserModel(); 
$id = $arr[2]; //读取用户信息 
$user_info = $model->find($id); 
echo json_encode($user_info); 
}

这样,我们就实现了一个Restful风格的API。

下面,我们再看如何实现读取用户列表的接口,传统方式: http://www.test.com/user/list
使用Restful风格,可以更加简洁:

http://www.test.com/user

和读取用户信息的区别是,user后面没有id,所以我们可以在读取部分的基础上做一下修改:

if($arr[1] == 'user'){ 
$model = new UserModel(); 
$id = $arr[2]; if($id){ //读取用户信息 
$user_info = $model->find($id); 
echo json_encode($user_info); 
}else{ //读取用户列表 
$user_list = $model->select(); 
echo json_encode($user_list); } }

这样就实现了读取用户列表的接口。

下面再看如何实现增加用户的接口,传统方式:

http://www.test.com/user/add

Restful风格:

http://www.test.com/user
和读取用户列表的接口是一样的,怎么区分呢?其实很简单,读取是GET请求,而增加是POST请求,用户信息都存在POST参数中,所以可以对代码进行下面的修改:

if($arr[1] == 'user'){ 
$model = new UserModel(); 
$id = $arr[2]; 
if($id){ //读取用户信息 
$user_info = $model->find($id); 
echo json_encode($user_info); 
}else{ 
if(IS_POST){ //增加用户 
$res = $model->add($_POST); 
if($res){ echo 'success'; 
}else{ echo 'fail'; } 
}else{ //读取用户列表 
$user_list = $model->select(); 
echo json_encode($user_list); } } }

同样的接口,可以依据HTTP请求方式来执行不同的逻辑。
这就是实现Restful风格API的核心思路,依次类推,我们可以实现编辑用户接口和删除用户接口:

http://www.test.com/user/1
只要使用不同的请求方式,就能区分开了。我们可以用PUT请求来执行编辑操作,用DELETE请求来执行删除操作。

具体代码就不写了,有兴趣的朋友可以自己尝试实现以下。

在Thinkphp框架中也提供了对Restful风格的支持,原理也是类似的。

总结一下,Restful风格就是,使用简单的URL和HTTP请求方式来实现接口。

PHPRS github

这是一个轻量级框架,专为快速开发RESTful接口而设计。如果你和我一样,厌倦了使用传统的MVC框架编写微服务或者前后端分离的API接口,受不了为了一个简单接口而做的很多多余的coding(和CTRL-C/CTRL-V),那么,你肯定会喜欢这个框架!

先举个栗子

写个HelloWorld.php,放到框架指定的目录下(默认是和index.php同级的apis/目录)

/**
 * @path("/hw")
 */
class HelloWorld
{
  /** 
   * @route({"GET","/"})
   */
  public function doSomething() {
    return "Hello World!";
  }
}

浏览器输入http://your-domain/hw/

你将看到:Hello World!就是这么简单,不需要额外配置,不需要继承也不需要组合。

发生了什么

回过头看HelloWorld.php,特殊的地方在于注释(@path,@route),没错,框架通过注释获取路由信息和绑定输入输出。但不要担心性能,注释只会在类文件修改后解析一次。更多的@注释后面会说明。

再看个更具体的例子

这是一个登录接口的例子

/**
 * 用户权限验证
 * @path("/tokens/") 
 */
class Tokens
{ 
  /**
   * 登录
   * 通过用户名密码授权
   * @route({"POST","/accounts/"}) 
   * @param({"account", "$._POST.account"}) 账号
   * @param({"password", "$._POST.password"}) 密码
   * 
   * @throws ({"InvalidPassword", "res", "403 Forbidden", {"error":"InvalidPassword"} }) 用户名或密码无效
   * 
   * @return({"body"})  
   * 返回token,同cookie中的token相同,
   * {"token":"xxx", "uid" = "xxx"}
   *
   * @return({"cookie","token","$token","+365 days","/"}) 通过cookie返回token
   * @return({"cookie","uid","$uid","+365 days","/"}) 通过cookie返回uid
   */
  public function createTokenByAccounts($account, $password, &$token,&$uid){
    //验证用户
    $uid = $this->users->verifyPassword($account, $password);
    Verify::isTrue($uid, new InvalidPassword($account));
    $token = ...;
    return ['token'=>$token, 'uid'=>$uid];
  } 
  /**
   * @property({"default":"@Users"})  依赖的属性,由框架注入
   * @var Users
   */
  public $users;
}

还能做什么

  1. 依赖管理(依赖注入),
  2. 自动输出接口文档(不是doxgen式的类、方法文档,而是描述http接口的文档)
  3. 接口缓存
  4. hook

配合ezsql访问数据库

ezsql是一款简单的面向对象的sql构建工具,提供简单的基本sql操作。

接口

/** @path(/myclass) */
class MyClass{

  /**
  * @route({"GET","/do"})
  * @param({"arg0","$._GET.arg0"})
  */
  public doSomething($arg0){
    return Sql::select('xxx')->from('table_xxx')->where( 'xxx = ?', $arg0)->get($this->db);
  }
  /**
   * 依赖注入PDO实例
   * @property
   * @var PDO
   */
  public $db;
}

配置文件

{
  {
    "MyClass":{
      "properties":{
        "db":"@db1"   
      }
    },
  },
  "db1":{
    "singleton":true,
    "class":"PDO",
    "pass_by_construct":true,
    "properties":{
      "dsn":"mysql:host=127.0.0.1;dbname=xxx",
      "username":"xxxx",
      "passwd":"xxxx"      
    }
  },
}
PHP 相关文章推荐
支持oicq头像的留言簿(一)
Oct 09 PHP
php+mysql事务rollback&commit示例
Feb 08 PHP
一个基于PDO的数据库操作类
Mar 24 PHP
QQ登录 PHP OAuth示例代码
Jul 20 PHP
PHP循环遍历数组的3种方法list()、each()和while总结
Nov 19 PHP
php读取mssql的ntext字段返回值为空的解决方法
Dec 30 PHP
在Mac OS上自行编译安装Apache服务器和PHP解释器
Dec 24 PHP
php处理json格式数据经典案例总结
May 19 PHP
php微信公众平台开发之微信群发信息
Sep 13 PHP
PHP数组相加操作及与array_merge的区别浅析
Nov 26 PHP
微信开发之php表单微信中自动提交两次问题解决办法
Jan 08 PHP
ThinkPHP框架表单验证操作方法
Jul 19 PHP
PHP实现查询两个数组中不同元素的方法
Feb 23 #PHP
PHP查询并删除数据库多列重复数据的方法(利用数组函数实现)
Feb 23 #PHP
php读取txt文件并将数据插入到数据库
Feb 23 #PHP
PHP调试的强悍利器之PHPDBG
Feb 22 #PHP
PHP Imagick完美实现图片裁切、生成缩略图、添加水印
Feb 22 #PHP
PHP实现linux命令tail -f
Feb 22 #PHP
PHP设计模式之观察者模式实例
Feb 22 #PHP
You might like
整合了前面的PHP数据库连接类~~做成一个分页类!
2006/11/25 PHP
php 处理上百万条的数据库如何提高处理查询速度
2010/02/08 PHP
PHP安全技术之 实现php基本安全
2010/09/04 PHP
Drupal读取Excel并导入数据库实例
2014/03/02 PHP
php制作圆形用户头像的实例_自定义封装类源代码
2017/09/18 PHP
PHP时间相关常用函数用法示例
2020/06/03 PHP
chrome原生方法之数组
2011/11/30 Javascript
javascript 进阶篇1 正则表达式,cookie管理,userData
2012/03/14 Javascript
node.js中的path.join方法使用说明
2014/12/08 Javascript
jquery读取xml文件实现省市县三级联动的方法
2015/05/29 Javascript
不定义JQuery插件 不要说会JQuery
2016/03/07 Javascript
AngularJS 与Bootstrap实现表格分页实例代码
2016/10/14 Javascript
JavaScript实现多栏目切换效果
2016/12/12 Javascript
bootstrapValidator.min.js表单验证插件
2017/02/09 Javascript
react-native ListView下拉刷新上拉加载实现代码
2017/08/03 Javascript
ES6 Class中实现私有属性的一些方法总结
2019/07/08 Javascript
Vue-CLI 项目在pycharm中配置方法
2019/08/30 Javascript
js实现网页随机验证码
2020/10/19 Javascript
JavaScript使用setTimeout实现倒计时效果
2021/02/19 Javascript
python 遍历目录(包括子目录)下所有文件的实例
2018/07/11 Python
django ModelForm修改显示缩略图 imagefield类型的实例
2019/07/28 Python
Pyinstaller 打包exe教程及问题解决
2019/08/16 Python
python 使用while循环输出*组成的菱形实例
2020/04/12 Python
Django 解决distinct无法去除重复数据的问题
2020/05/20 Python
利用python+request通过接口实现人员通行记录上传功能
2021/01/13 Python
CSS3实现红包抖动效果
2020/12/23 HTML / CSS
中国跨境在线时尚零售商:Bellelily
2018/04/06 全球购物
eBay奥地利站:eBay.at
2019/07/24 全球购物
Theflamel意大利:女士奢华服装、鞋子和配件
2020/01/11 全球购物
竞争性谈判邀请书
2014/02/06 职场文书
个人培训自我鉴定
2014/03/28 职场文书
5s推行计划书
2014/05/06 职场文书
班组拓展活动方案
2014/08/14 职场文书
订货会邀请函
2015/01/31 职场文书
开学第一周值周总结
2015/07/16 职场文书
MySQL索引是啥?不懂就问
2021/07/21 MySQL