PHP编写RESTful接口

首先我们来认识下RESTful

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

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

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

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

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

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

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

?

1 2 3

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

得到下面的结果：

?

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

获取到了参数，下面的操作就很简单了：

?

1 2 3 4 5 6

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，所以我们可以在读取部分的基础上做一下修改：

?

1 2 3 4 5 6 7 8

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参数中，所以可以对代码进行下面的修改：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14

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/目录）

?

1 2 3 4 5 6 7 8 9 10 11 12

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

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

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

发生了什么

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

再看个更具体的例子

这是一个登录接口的例子

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

/**   * 用户权限验证   * @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操作。

接口

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

/** @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 ; }

配置文件

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

{    {      "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"           }    }, }