程式師世界 >> 編程語言 >> 網頁編程 >> PHP編程 >> PHP綜合 >> PHP編寫RESTful接口

PHP編寫RESTful接口

編輯：PHP綜合

首先我們來認識下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;
}

還能做什麼

依賴管理（依賴注入），
自動輸出接口文檔（不是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"      
    }
  },
}