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防注
Jan 15 PHP
快速开发一个PHP扩展图文教程
Dec 12 PHP
PHP+jQuery实现自动补全功能源码
May 15 PHP
PHP 获取ip地址代码汇总
Jul 05 PHP
PHP和MySql中32位和64位的整形范围是多少
Feb 18 PHP
PHP对XML内容进行修改和删除实例代码
Oct 26 PHP
php实用代码片段整理
Nov 12 PHP
php获取POST数据的三种方法实例详解
Dec 20 PHP
PHP随机获取未被微信屏蔽的域名(微信域名检测)
Mar 19 PHP
PHP中的函数声明与使用详解
May 27 PHP
PHP通过GD库实现验证码功能示例
Feb 23 PHP
Mac系统下搭建Nginx+php-fpm实例讲解
Dec 15 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
实用函数8
2007/11/08 PHP
php学习之运算符相关概念
2011/06/09 PHP
php链表用法实例分析
2015/07/09 PHP
PHP的全局错误处理详解
2016/04/25 PHP
深入理解PHP 数组之count 函数
2016/06/13 PHP
PHP Mysqli 常用代码集合
2016/11/12 PHP
Thinkphp开发--集成极光推送
2017/09/15 PHP
JavaScript实用技巧(一)
2010/08/16 Javascript
JQuery $.each遍历JavaScript数组对象实例
2014/09/01 Javascript
浅析Node.js查找字符串功能
2014/09/03 Javascript
javascript使用正则表达式检测IP地址
2014/12/03 Javascript
jQuery结合HTML5制作的爱心树表白动画
2015/02/01 Javascript
javaScript中slice函数用法实例分析
2015/06/08 Javascript
jQuery实现鼠标划过添加和删除class的方法
2015/06/26 Javascript
js实现适用于素材网站的黑色多级菜单导航条效果
2015/08/24 Javascript
RequireJS入门一之实现第一个例子
2015/09/30 Javascript
js识别uc浏览器的代码
2015/11/06 Javascript
Javascript的表单验证长度
2016/03/16 Javascript
限制文本框只能输入数字||只能是数字和小数点||只能是整数和浮点数
2016/05/27 Javascript
全面解析Bootstrap中transition、affix的使用方法
2016/05/30 Javascript
使用node.js搭建服务器
2017/05/20 Javascript
JavaScript上传文件时不用刷新页面方法总结(推荐)
2017/08/15 Javascript
Vue 2.5 Level E 发布了: 新功能特性一览
2017/10/24 Javascript
详解Vue单元测试Karma+Mocha学习笔记
2018/01/31 Javascript
Javascript实现异步编程的过程
2018/06/18 Javascript
微信小程序顶部导航栏滑动tab效果
2019/01/28 Javascript
JavaScript适配器模式原理与用法实例详解
2020/03/09 Javascript
python itchat实现微信自动回复的示例代码
2017/08/14 Python
Python多线程爬虫实战_爬取糗事百科段子的实例
2017/12/15 Python
python设定并获取socket超时时间的方法
2019/01/12 Python
详解Python匿名函数(lambda函数)
2019/04/19 Python
基于Tensorflow读取MNIST数据集时网络超时的解决方式
2020/06/22 Python
入党自我鉴定范文
2013/10/04 职场文书
公司新年寄语
2014/04/04 职场文书
初中生评语大全
2014/04/24 职场文书
初中政治教学反思
2016/02/23 职场文书