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 相关文章推荐
php 过滤危险html代码
Jun 29 PHP
php UTF-8、Unicode和BOM问题
May 18 PHP
PHP中文件缓存转内存缓存的方法
Dec 06 PHP
PHP 设计模式之观察者模式介绍
Feb 22 PHP
php实现的九九乘法口诀表简洁版
Jul 28 PHP
PHP使用静态方法的几个注意事项
Sep 16 PHP
PHP数学运算与数据处理实例分析
Apr 01 PHP
PHP中in_array的隐式转换的解决方法
Mar 06 PHP
Laravel模型事件的实现原理详解
Mar 14 PHP
php使用curl_init()和curl_multi_init()多线程的速度比较详解
Aug 15 PHP
php判断数组是否为空的实例方法
May 10 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
利用curl抓取远程页面内容的示例代码
2013/07/23 PHP
php处理抢购类功能的高并发请求
2018/02/08 PHP
phpstorm最新激活码分享亲测phpstorm2020.2.3版可用
2020/11/22 PHP
基于jquery中children()与find()的区别介绍
2013/04/26 Javascript
触屏中的JavaScript事件分析
2015/02/06 Javascript
javascript通过元素id和name直接取得元素的方法
2015/04/28 Javascript
浅谈JavaScript的自动垃圾收集机制
2016/12/15 Javascript
js代码延迟一定时间后执行一个函数的实例
2017/02/15 Javascript
Vue.js教程之axios与网络传输的学习实践
2017/04/29 Javascript
深入理解Node中的buffer模块
2017/06/03 Javascript
移动端触摸滑动插件swiper使用方法详解
2017/08/11 Javascript
js 提取某()特殊字符串长度的实例
2017/12/06 Javascript
webpack引入eslint配置详解
2018/01/22 Javascript
vue实现a标签点击高亮方法
2018/03/17 Javascript
深入理解react-router 路由的实现原理
2018/09/26 Javascript
详解JS浏览器事件循环机制
2019/03/27 Javascript
vue使用自定义指令实现拖拽
2021/01/29 Javascript
jQuery实现动态向上滚动
2020/12/21 jQuery
python开发之str.format()用法实例分析
2016/02/22 Python
Python简单格式化时间的方法【strftime函数】
2016/09/18 Python
Python Flask基础教程示例代码
2018/02/07 Python
Python操作word常见方法示例【win32com与docx模块】
2018/07/17 Python
pycharm使用matplotlib.pyplot不显示图形的解决方法
2018/10/28 Python
python多线程实现TCP服务端
2019/09/03 Python
中间件分为哪几类
2016/09/18 面试题
小学生打架检讨书
2014/01/26 职场文书
安全检查管理制度
2014/02/02 职场文书
电焊工工作岗位职责
2014/02/06 职场文书
致100米运动员广播稿
2014/02/14 职场文书
国旗下演讲稿
2014/05/08 职场文书
自我查摆剖析材料
2014/10/11 职场文书
社区党风廉政建设调研报告
2015/01/01 职场文书
2015年八一建军节演讲稿
2015/03/19 职场文书
学校隐患排查制度
2015/08/05 职场文书
房产销售员2015年终工作总结
2015/10/22 职场文书
学术会议开幕词
2016/03/03 职场文书