首先我们来认识下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. $path = $_SERVER['PATH_INFO'];  
2. $arr = explode('/',$path);  
3. print_r($arr); 

得到下面的结果：

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

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

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

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

下面，我们再看如何实现读取用户列表的接口，传统方式： http://www.test.com/user/list

使用Restful风格，可以更加简洁：

http://www.test.com/user

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

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

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

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

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

Restful风格：

http://www.test.com/user

和读取用户列表的接口是一样的，怎么区分呢？其实很简单，读取是GET请求，而增加是POST请求，用户信息都存在POST参数中，所以可以对代码进行下面的修改：

1. if($arr[1] == 'user'){  
2. $model = new UserModel();  
3. $id = $arr[2];  
4. if($id){ //读取用户信息  
5. $user_info = $model->find($id);  
6. echo json_encode($user_info);  
7. }else{  
8. if(IS_POST){ //增加用户  
9. $res = $model->add($_POST);  
10. if($res){ echo 'success';  
11. }else{ echo 'fail'; }  
12. }else{ //读取用户列表  
13. $user_list = $model->select();  
14. 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.  * @path("/hw") 
3.  */ 
4. class HelloWorld 
5. { 
6.   /**  
7.    * @route({"GET","/"}) 
8.    */ 
9.   public function doSomething() { 
10.     return "Hello World!"; 
11.   } 
12. } 

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

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

发生了什么

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

再看个更具体的例子

这是一个登录接口的例子

1. /** 
2.  * 用户权限验证 
3.  * @path("/tokens/")  
4.  */ 
5. class Tokens 
6. {  
7.   /** 
8.    * 登录 
9.    * 通过用户名密码授权 
10.    * @route({"POST","/accounts/"})  
11.    * @param({"account", "$._POST.account"}) 账号 
12.    * @param({"password", "$._POST.password"}) 密码 
13.    *  
14.    * @throws ({"InvalidPassword", "res", "403 Forbidden", {"error":"InvalidPassword"} }) 用户名或密码无效 
15.    *  
16.    * @return({"body"})   
17.    * 返回token，同cookie中的token相同, 
18.    * {"token":"xxx", "uid" = "xxx"} 
19.    * 
20.    * @return({"cookie","token","$token","+365 days","/"}) 通过cookie返回token 
21.    * @return({"cookie","uid","$uid","+365 days","/"}) 通过cookie返回uid 
22.    */ 
23.   public function createTokenByAccounts($account, $password, &$token,&$uid){ 
24.     //验证用户 
25.     $uid = $this->users->verifyPassword($account, $password); 
26.     Verify::isTrue($uid, new InvalidPassword($account)); 
27.     $token = ...; 
28.     return ['token'=>$token, 'uid'=>$uid]; 
29.   }  
30.   /** 
31.    * @property({"default":"@Users"})  依赖的属性，由框架注入 
32.    * @var Users 
33.    */ 
34.   public $users; 
35. } 

还能做什么

依赖管理（依赖注入），自动输出接口文档（不是doxgen式的类、方法文档，而是描述http接口的文档）

接口缓存

hook

配合ezsql访问数据库

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

接口

1. /** @path(/myclass) */ 
2. class MyClass{ 
3.  
4.   /** 
5.   * @route({"GET","/do"}) 
6.   * @param({"arg0","$._GET.arg0"}) 
7.   */ 
8.   public doSomething($arg0){ 
9.     return Sql::select('xxx')->from('table_xxx')->where( 'xxx = ?', $arg0)->get($this->db); 
10.   } 
11.   /** 
12.    * 依赖注入PDO实例 
13.    * @property 
14.    * @var PDO 
15.    */ 
16.   public $db; 
17. } 

配置文件

1. { 
2.   { 
3.     "MyClass":{ 
4.       "properties":{ 
5.         "db":"@db1"   
6.       } 
7.     }, 
8.   }, 
9.   "db1":{ 
10.     "singleton":true, 
11.     "class":"PDO", 
12.     "pass_by_construct":true, 
13.     "properties":{ 
14.       "dsn":"mysql:host=127.0.0.1;dbname=xxx", 
15.       "username":"xxxx", 
16.       "passwd":"xxxx"      
17.     } 
18.   }, 
19. }

Tags: RESTful接口

分享到：