API介面開發簡述示例

Noah_WB發表於2023-02-20
API

作為最流行的服務端語言 PHP（PHP: Hypertext Preprocessor），在開發 API 方面，是很簡單且極具優勢的。API（Application Programming Interface，應用程式介面）架構，已經成為目前網際網路產品開發中常見的軟體架構模式，並且誕生很多專門 API 服務的公司，先了解下 API ：

1、API 比開發 WEB 更簡潔，但可能邏輯更復雜，API 只返回結果，也就是隻完成資料輸出，不呈現頁面， 2、WEB 開發，更多的是 GET 和 POST 請求，API 還有 PUT、DELETE 請求 3、和 WEB 開發一樣，首先需要一些相關的引數，這些引數，都會由客戶端傳過來，也許是 GET 也許是 POST，這個需要開發團隊相互之間約定好，或者制定統一規範 4、有了引數，根據應用需求，完成資料處理，例如：獲取使用者資訊、發朋友圈、發訊息、一局遊戲結束資料提交等等 5、資料邏輯處理完之後，返回客戶端所需要用到的相關資料，例如：使用者資訊陣列、朋友圈列表、訊息狀態、遊戲結果資料等等，那資料是怎麼返給客戶端呢？常見有 XML、JSON，設定相應的 header 並把要返回的資料直接列印出來即可 6、客戶端獲取到你返回的資料後，在客戶端本地和使用者進行互動

所以我們大概知道，API 其實不存在 Web 領域的 MVC 架構模式，若要分層的，API 也只有 M 和 C 兩層，當然，後端可能會有更加複雜的架構！

透過下面一個 HTTP 協議的 API 例項來理解 PHP 怎麼開發 API：

<?php/**
* 比較標準的介面輸出函式
* @param string  $info 訊息
* @param integer $code 介面錯誤碼，很關鍵的引數
* @param array   $data 附加資料
* $param string  $location 重定向
* @return array
*/function var_json($info = '', $code = 10000, $data = array(), $location = '') {    $out['code'] = $code ?: 0;    $out['info'] = $info ?: ($out['code'] ? 'error' : 'success');    $out['data'] = $data ?: array();    $out['location'] = $location;
    header('Content-Type: application/json; charset=utf-8');    echo json_encode($out, JSON_HEX_TAG);    exit(0);
}$a = empty($_GET['a']) ? '' : $_GET['a'];$qq = empty($_GET['qq']) ? 0 : intval($_GET['qq']);//假設這是資料來源，如 MySQL$data = array();$data[85464277] = array('qq'=>85464277, 'vip'=>7,'level'=>128, 'reg_time'=>1376523234, 'qb'=>300);$data[97656177] = array('qq'=>97656177, 'vip'=>5,'level'=>101, 'reg_time'=>1377123144, 'qb'=>300);
preg_match('/^[a-zA-Z]+$/', $a) || var_json('非法呼叫');isset($data[$qq]) || var_json('使用者不存在', 100001);switch ($a) {    //獲取使用者基本資訊
    case 'info': 
        //你的更多業務邏輯 ...
        var_json('success', 0, $data[$qq]);        break;    //獲取動態訊息
    case 'message':
        var_json('您正在呼叫動態訊息介面', 0);        break;    //獲取好友列表
    case 'friends':
        var_json('你正在呼叫好友列表介面', 0);        break;    default:
        var_json('非法呼叫');
}

介面輸出示例，返回的是一串 json：

{
        "code": 0,
        "info": "success",
        "data": {
                "qq": 85464277,
                "vip": 7,
                "level": 128,
                "reg_time": 1376523234,
                "qb": 300
        },
        "location": ""}

json 具有很強的跨平臺性，幾乎每種語言都有解析 json 的函式，下面是一個 PHP 作為客戶端呼叫的示例：

<?php 
header('Content-type:text/html;charset=utf-8'); 
$url = "http://demo.qq52o.cn/api/test/user.php?a=info&qq=85464277"; 
$arg = array( 
    'a' => 'info',    'qq' => '85464277',
);$query_string = http_build_query($arg);$ch = curl_init($url.'?'.$query_string);
curl_setopt($ch, CURLOPT_HTTP_VERSION , CURL_HTTP_VERSION_1_1);
curl_setopt($ch, CURLOPT_USERAGENT , 'QQ_Mobile_V5.5');
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT , 60 );
curl_setopt($ch, CURLOPT_TIMEOUT , 60);
curl_setopt($ch, CURLOPT_RETURNTRANSFER , true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);$response = curl_exec($ch);$httpcode = curl_getinfo($ch , CURLINFO_HTTP_CODE);
curl_close($ch);if ($response === false) {
    var_dump(curl_error($ch));
} elseif ($httpcode != 200) {
    var_dump($httpcode, '介面請求失敗');
} else {    $ret = json_decode($response, true);
    var_dump($ret);
}

頁面輸出結果：

array(4) {
    ["code"]=>int(0)
    ["info"]=>string(7) "success"
    ["data"]=>    array(5) {
        ["qq"]=>int(85464277)
        ["vip"]=>int(7)
        ["level"]=>int(128)
        ["reg_time"]=>int(1376523234)
        ["qb"]=>int(300)
    }
    ["location"]=>string(0) ""}

實際專案中，我們在開發 API 時應該注意的幾個點（僅供參考）

1、單檔案實現多介面的形式有很多種，例如：if..elseif.. 或 switch 或 很多框架裡用到的統一入口透過呼叫類函式的形式實現 2、資料輸出建議使用 json，json 具有很強的跨平臺性，大多程式語言都支援 json 解析，json 正在逐步取代 xml，成為網路資料的通用格式 3、為了保證介面安全，一定要加入鑑權體系 4、對於線上的 API，務必關閉所有錯誤顯示，可以把錯誤寫到日誌裡，PHP 中，可以透過 error_reporting(0) 遮蔽所有錯誤 這樣做的目的，一方面是保護介面安全，防止輸出不該列印的錯誤資訊 另一方面是保證輸出的是正確的資料格式，如 json，假如不是標準的 json 格式，客戶端在解析時就會出錯，由此影響客戶端的正常運轉 PS：我們平時在使用手機 APP 時，手機會閃退，多半是這個原因，即介面呼叫異常 5、開發 API 和 WEB 有一定的區別，如果是 WEB 的話，如果程式寫的有問題，比如有個 notice 或 warning 級別的錯誤，在 WEB 裡可能不會有什麼問題，也許就只是導致 WEB 的某個部分錯位或亂碼。但如果是 API，就會嚴重呼叫的客戶端了，如果是手機 APP，那閃推啥的，是必然的，如果同樣也是 Web 呼叫，也可能會出現  Server Error 了 6、一定要重點考慮穩定性和響應速度，因為我們在使用手機 APP 時，都不希望 APP 經常閃推、而且希望應用很流暢 7、不要隨便使用一些 PHP 開源框架，原因概括起來有兩點： ①如 6 所述，客戶端一般對 API 響應速度有極高要求，目前 PHP 領域的開源框架非常多，根據筆者的瞭解，目前比較流行的框架，普遍做的比較重，而且基本都是為 WEB 而生，因此，框架多了很多 API 用不到的東西，框架在載入和執行冗餘檔案時，實際是在消耗你的效能 ②如 4 和 5 所述，框架對於 WEB 開發，是件很幸福的事，但對於 API 而言，你實在不敢想象它會給你出什麼岔子，因為很多框架並沒有全面的考慮到 API 場景


來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/70026910/viewspace-2935990/，如需轉載，請註明出處，否則將追究法律責任。

相關文章