如何使用PHP編寫RESTful接口

時間 2019-11-10

標籤如何使用 php 編寫 restful 接口欄目 PHP 简体版

原文原文鏈接

PHPRS@github

這是一個輕量級框架，專爲快速開發RESTful接口而設計。若是你和我同樣，厭倦了使用傳統的MVC框架編寫微服務或者先後端分離的API接口，受不了爲了一個簡單接口而作的不少多餘的coding（和CTRL-C/CTRL-V），那麼，你確定會喜歡這個框架！php

先舉個栗子

寫個HelloWorld.php，放到框架指定的目錄下（默認是和index.php同級的apis/目錄）mysql

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

瀏覽器輸入http://your-domain/hw/
你將看到：Hello World!就是這麼簡單，不須要額外配置，不須要繼承也不須要組合。git

發生了什麼

回過頭看HelloWorld.php，特殊的地方在於註釋（@path，@route），沒錯，框架經過註釋獲取路由信息和綁定輸入輸出。但不要擔憂性能，註釋只會在類文件修改後解析一次。更多的@註釋後面會說明。github

再看個更具體的例子

這是一個登陸接口的例子sql

/**
 * 用戶權限驗證
 * @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接口的文檔）後端
接口緩存api
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"           
        }
    },
}