使用PHP怎么編寫(xiě)一個(gè)RESTful接口

今天就跟大家聊聊有關(guān)使用PHP怎么編寫(xiě)一個(gè)RESTful接口，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結(jié)了以下內(nèi)容，希望大家根據(jù)這篇文章可以有所收獲。

php有什么用

php是一個(gè)嵌套的縮寫(xiě)名稱(chēng)，是英文超級(jí)文本預(yù)處理語(yǔ)言，它的語(yǔ)法混合了C、Java、Perl以及php自創(chuàng)新的語(yǔ)法，主要用來(lái)做網(wǎng)站開(kāi)發(fā)，許多小型網(wǎng)站都用php開(kāi)發(fā)，因?yàn)閜hp是開(kāi)源的，從而使得php經(jīng)久不衰。

首先我們來(lái)認(rèn)識(shí)下RESTful

Restful是一種設(shè)計(jì)風(fēng)格而不是標(biāo)準(zhǔn)，比如一個(gè)接口原本是這樣的： http://kemok4.com/user/view/id/1

表示獲取id為1的用戶(hù)信息，如果使用Restful風(fēng)格，可以變成這樣：

http://kemok4.com/user/1

可以很明顯的看出這樣做的好處：

1、更簡(jiǎn)潔的URL，對(duì)程序員友好

2、不暴露內(nèi)部代碼結(jié)構(gòu)，更安全

那么，如何實(shí)現(xiàn)這個(gè)接口呢？首先，我們需要接收到/user/1部分。

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

得到下面的結(jié)果：

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

獲取到了參數(shù)，下面的操作就很簡(jiǎn)單了：

if($arr[1] == 'user'){ 
$model = new UserModel(); 
$id = $arr[2]; //讀取用戶(hù)信息 
$user_info = $model->find($id); 
echo json_encode($user_info); 
}

這樣，我們就實(shí)現(xiàn)了一個(gè)Restful風(fēng)格的API。

下面，我們?cè)倏慈绾螌?shí)現(xiàn)讀取用戶(hù)列表的接口，傳統(tǒng)方式： http://www.test.com/user/list
使用Restful風(fēng)格，可以更加簡(jiǎn)潔：

http://www.test.com/user

和讀取用戶(hù)信息的區(qū)別是，user后面沒(méi)有id，所以我們可以在讀取部分的基礎(chǔ)上做一下修改：

if($arr[1] == 'user'){ 
$model = new UserModel(); 
$id = $arr[2]; if($id){ //讀取用戶(hù)信息 
$user_info = $model->find($id); 
echo json_encode($user_info); 
}else{ //讀取用戶(hù)列表 
$user_list = $model->select(); 
echo json_encode($user_list); } }

這樣就實(shí)現(xiàn)了讀取用戶(hù)列表的接口。

下面再看如何實(shí)現(xiàn)增加用戶(hù)的接口，傳統(tǒng)方式：

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

Restful風(fēng)格：

http://www.test.com/user
和讀取用戶(hù)列表的接口是一樣的，怎么區(qū)分呢？其實(shí)很簡(jiǎn)單，讀取是GET請(qǐng)求，而增加是POST請(qǐng)求，用戶(hù)信息都存在POST參數(shù)中，所以可以對(duì)代碼進(jìn)行下面的修改：

if($arr[1] == 'user'){ 
$model = new UserModel(); 
$id = $arr[2]; 
if($id){ //讀取用戶(hù)信息 
$user_info = $model->find($id); 
echo json_encode($user_info); 
}else{ 
if(IS_POST){ //增加用戶(hù) 
$res = $model->add($_POST); 
if($res){ echo 'success'; 
}else{ echo 'fail'; } 
}else{ //讀取用戶(hù)列表 
$user_list = $model->select(); 
echo json_encode($user_list); } } }

同樣的接口，可以依據(jù)HTTP請(qǐng)求方式來(lái)執(zhí)行不同的邏輯。
這就是實(shí)現(xiàn)Restful風(fēng)格API的核心思路，依次類(lèi)推，我們可以實(shí)現(xiàn)編輯用戶(hù)接口和刪除用戶(hù)接口：

http://www.test.com/user/1
只要使用不同的請(qǐng)求方式，就能區(qū)分開(kāi)了。我們可以用PUT請(qǐng)求來(lái)執(zhí)行編輯操作，用DELETE請(qǐng)求來(lái)執(zhí)行刪除操作。

具體代碼就不寫(xiě)了，有興趣的朋友可以自己嘗試實(shí)現(xiàn)以下。

在Thinkphp框架中也提供了對(duì)Restful風(fēng)格的支持，原理也是類(lèi)似的。

總結(jié)一下，Restful風(fēng)格就是，使用簡(jiǎn)單的URL和HTTP請(qǐng)求方式來(lái)實(shí)現(xiàn)接口。

PHPRS github

這是一個(gè)輕量級(jí)框架，專(zhuān)為快速開(kāi)發(fā)RESTful接口而設(shè)計(jì)。如果你和我一樣，厭倦了使用傳統(tǒng)的MVC框架編寫(xiě)微服務(wù)或者前后端分離的API接口，受不了為了一個(gè)簡(jiǎn)單接口而做的很多多余的coding（和CTRL-C/CTRL-V），那么，你肯定會(huì)喜歡這個(gè)框架！

先舉個(gè)栗子

寫(xiě)個(gè)HelloWorld.php，放到框架指定的目錄下（默認(rèn)是和index.php同級(jí)的apis/目錄）

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

瀏覽器輸入http://your-domain/hw/

你將看到：Hello World!就是這么簡(jiǎn)單，不需要額外配置，不需要繼承也不需要組合。

發(fā)生了什么

回過(guò)頭看HelloWorld.php，特殊的地方在于注釋?zhuān)ˊpath，@route），沒(méi)錯(cuò)，框架通過(guò)注釋獲取路由信息和綁定輸入輸出。但不要擔(dān)心性能，注釋只會(huì)在類(lèi)文件修改后解析一次。更多的@注釋后面會(huì)說(shuō)明。

再看個(gè)更具體的例子

這是一個(gè)登錄接口的例子

/**
 * 用戶(hù)權(quán)限驗(yàn)證
 * @path("/tokens/") 
 */
class Tokens
{ 
  /**
   * 登錄
   * 通過(guò)用戶(hù)名密碼授權(quán)
   * @route({"POST","/accounts/"}) 
   * @param({"account", "$._POST.account"}) 賬號(hào)
   * @param({"password", "$._POST.password"}) 密碼
   * 
   * @throws ({"InvalidPassword", "res", "403 Forbidden", {"error":"InvalidPassword"} }) 用戶(hù)名或密碼無(wú)效
   * 
   * @return({"body"})  
   * 返回token，同cookie中的token相同,
   * {"token":"xxx", "uid" = "xxx"}
   *
   * @return({"cookie","token","$token","+365 days","/"}) 通過(guò)cookie返回token
   * @return({"cookie","uid","$uid","+365 days","/"}) 通過(guò)cookie返回uid
   */
  public function createTokenByAccounts($account, $password, &$token,&$uid){
    //驗(yàn)證用戶(hù)
    $uid = $this->users->verifyPassword($account, $password);
    Verify::isTrue($uid, new InvalidPassword($account));
    $token = ...;
    return ['token'=>$token, 'uid'=>$uid];
  } 
  /**
   * @property({"default":"@Users"})  依賴(lài)的屬性，由框架注入
   * @var Users
   */
  public $users;
}

還能做什么

1. 依賴(lài)管理（依賴(lài)注入），

2. 自動(dòng)輸出接口文檔（不是doxgen式的類(lèi)、方法文檔，而是描述http接口的文檔）

3. 接口緩存

4. hook
   

配合ezsql訪問(wèn)數(shù)據(jù)庫(kù)

ezsql是一款簡(jiǎn)單的面向?qū)ο蟮膕ql構(gòu)建工具，提供簡(jiǎn)單的基本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);
  }
  /**
   * 依賴(lài)注入PDO實(shí)例
   * @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"      
    }
  },
}

看完上述內(nèi)容，你們對(duì)使用PHP怎么編寫(xiě)一個(gè)RESTful接口有進(jìn)一步的了解嗎？如果還想了解更多知識(shí)或者相關(guān)內(nèi)容，請(qǐng)關(guān)注億速云行業(yè)資訊頻道，感謝大家的支持。