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中include()与require()的区别说明
Mar 10 PHP
php 模拟get_headers函数的代码示例
Apr 27 PHP
深入理解php的MySQL连接类
Jun 07 PHP
解析二进制流接口应用实例 pack、unpack、ord 函数使用方法
Jun 18 PHP
php正则取img标记中任意属性(正则替换去掉或改变图片img标记中的任意属性)
Aug 13 PHP
php返回当前日期或者指定日期是周几
May 21 PHP
[原创]php逐行读取txt文件写入数组的方法
Jul 02 PHP
PHP获取客户端及服务器端IP的封装类
Jul 21 PHP
ThinkPHP实现附件上传功能
Apr 27 PHP
PHP一个简单的无需刷新爬虫
Jan 05 PHP
php生成静态页面并实现预览功能
Jun 27 PHP
php中对象引用和复制实例分析
Aug 14 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中在数据库中保存Checkbox数据(1)
2006/10/09 PHP
php2html php生成静态页函数
2008/12/08 PHP
php Xdebug 调试扩展的安装与使用.
2010/03/13 PHP
php中创建和调用webservice接口示例
2014/07/25 PHP
thinkphp多层MVC用法分析
2015/12/30 PHP
php设计模式之抽象工厂模式分析【星际争霸游戏案例】
2020/01/23 PHP
php使用goto实现自动重启swoole、reactphp、workerman服务的代码
2020/04/13 PHP
js生成随机数之random函数随机示例
2013/12/20 Javascript
JavaScript html5 canvas画布中删除一个块区域的方法
2016/01/26 Javascript
详解nodejs 文本操作模块-fs模块(五)
2016/12/23 NodeJs
canvas实现探照灯效果
2017/02/07 Javascript
微信小程序 支付功能开发错误总结
2017/02/21 Javascript
js实现网页定位导航功能
2017/03/07 Javascript
微信小程序时间选择插件使用详解
2018/12/28 Javascript
element-ui 文件上传修改文件名的方法示例
2019/11/05 Javascript
js实现文章目录索引导航(table of content)
2020/05/10 Javascript
深入了解JavaScript词法作用域
2020/07/29 Javascript
[01:13:08]2018DOTA2亚洲邀请赛4.6 淘汰赛 mineski vs LGD 第二场
2018/04/10 DOTA
python利用拉链法实现字典方法示例
2017/03/25 Python
Python实现简单的HttpServer服务器示例
2017/09/25 Python
python打开使用的方法
2019/09/30 Python
Python enumerate函数遍历数据对象组合过程解析
2019/12/11 Python
基于python求两个列表的并集.交集.差集
2020/02/10 Python
Pycharm Available Package无法显示/安装包的问题Error Loading Package List解决
2020/09/18 Python
css背景图片的背景裁切、背景透明度、背景变换等效果运用
2012/12/24 HTML / CSS
从一次项目重构说起CSS3自定义变量在项目的使用方法
2021/03/01 HTML / CSS
Canvas绘制浮动球效果的示例
2017/12/29 HTML / CSS
俄罗斯隐形眼镜和眼镜在线商店:Cronos
2020/06/02 全球购物
国贸专业的职业规划范文
2014/01/23 职场文书
九年级英语教学反思
2014/01/31 职场文书
大学信息公开实施方案
2014/03/09 职场文书
学习经验交流会主持词
2014/04/01 职场文书
银行求职信范文
2014/05/26 职场文书
同学聚会开幕词
2019/04/02 职场文书
Navicat for MySQL的使用教程详解
2021/05/27 MySQL
Vertica集成Apache Hudi重磅使用指南
2022/03/31 Servers