PHP编写RESTful接口

程序员文章站 2024-04-01 18:28:46

首先我们来认识下restful restful是一种设计风格而不是标准，比如一个接口原本是这样的：表示获取id为1的用户信息，如果使用restful风格，可以变...

首先我们来认识下restful

restful是一种设计风格而不是标准，比如一个接口原本是这样的：

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

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

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。

下面，我们再看如何实现读取用户列表的接口，传统方式：
使用restful风格，可以更加简洁：

和读取用户信息的区别是，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); } }

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

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

restful风格：

和读取用户列表的接口是一样的，怎么区分呢？其实很简单，读取是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的核心思路，依次类推，我们可以实现编辑用户接口和删除用户接口：

只要使用不同的请求方式，就能区分开了。我们可以用put请求来执行编辑操作，用delete请求来执行删除操作。

具体代码就不写了，有兴趣的朋友可以自己尝试实现以下。

在thinkphp框架中也提供了对restful风格的支持，原理也是类似的。

总结一下，restful风格就是，使用简单的url和http请求方式来实现接口。

phprs

这是一个轻量级框架，专为快速开发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!";
  }
}

浏览器输入

你将看到：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;
}

还能做什么

依赖管理（依赖注入），
自动输出接口文档（不是doxgen式的类、方法文档，而是描述http接口的文档）
接口缓存
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实现截取中文字符串不出现?号的解决方法

下一篇：详谈jvm--Java中init和clinit的区别

PHP编写RESTful接口