一個簡單 API 例子：

作過 API 的人應該瞭解，其實開發 API 比開發 WEB 更簡潔，但可能邏輯更復雜，由於 API 其實就是數據輸出，不用呈現頁面，因此也就不存在 MVC（API 只有 M 和 C），
一、和 WEB 開發同樣，首先須要一些相關的參數，這些參數，都會由客戶端傳過來，也許是 GET 也許是 POST，這個須要開發團隊相互之間約定好，或者制定統一規範。
二、有了參數，根據應用需求，完成數據處理，例如：任務進度更新、APP內購、一局遊戲結束數據提交等等
三、數據邏輯處理完以後，返回客戶端所須要用到的相關數據，例如：任務狀態、內購結果、玩家信息等等
數據怎麼返給客戶端？
直接輸出的形式，如：JSON、XML、TEXT 等等。
四、客戶端獲取到你返回的數據後，在客戶端本地和用戶進行交互

<?php
$output = array();
$a = @$_GET['a'] ? $_GET['a'] : '';
$uid = @$_GET['uid'] ? $_GET['uid'] : 0;

if (empty($a)) {
    $output = array('data'=>NULL, 'info'=>'坑爹啊!', 'code'=>-201);
    exit(json_encode($output));
}

//走接口
if ($a == 'get_users') {
    //檢查用戶
    if ($uid == 0) {
        $output = array('data'=>NULL, 'info'=>'The uid is null!', 'code'=>-401);
        exit(json_encode($output));
    }

    //假設 $mysql 是數據庫
    $mysql = array(
        10001 => array(
            'uid'=>10001,
            'vip'=>5,
            'nickname' => 'Shine X',
            'email'=>'979137@qq.com',
            'qq'=>979137,
            'gold'=>1500,
            'powerplay'=> array('2xp'=>12,'gem'=>12,'bingo'=>5,'keys'=>5,'chest'=>8),
            'gems'=> array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17),
            'ctime'=>1376523234,
            'lastLogin'=>1377123144,
            'level'=>19,
            'exp'=>16758,
        ),
        10002 => array(
            'uid'=>10002,
            'vip'=>50,
            'nickname' => 'elva',
            'email'=>'elva@ezhi.net',
            'qq'=>NULL,
            'gold'=>14320,
            'powerplay'=> array('2xp'=>1,'gem'=>120,'bingo'=>51,'keys'=>5,'chest'=>8),
            'gems'=> array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17),
            'ctime'=>1376523234,
            'lastLogin'=>1377123144,
            'level'=>112,
            'exp'=>167588,
        ),
        10003 => array(
            'uid' => 10003,
            'vip' => 5,
            'nickname' => 'Lily',
            'email' => 'Lily@ezhi.net',
            'qq' => NULL,
            'gold' => 1541,
            'powerplay'=> array('2xp'=>2,'gem'=>112,'bingo'=>4,'keys'=>7,'chest'=>8),
            'gems' => array('red'=>13,'green'=>3,'blue'=>9,'yellow'=>7),
            'ctime' => 1376523234,
            'lastLogin'=> 1377123144,
            'level' => 10,
            'exp' => 1758,
        ),
    );
    
    $uidArr = array(10001,10002,10003);
    if (in_array($uid, $uidArr, true)) {
        $output = array('data' => NULL, 'info'=>'The user does not exist!', 'code' => -402);
        exit(json_encode($output));
    }

    //查詢數據庫
    $userInfo = $mysql[$uid];
    
    //輸出數據
    $output = array(
        'data' => array(
            'userInfo' => $userInfo,
            'isLogin' => true,//是否首次登錄
            'unread' => 4,//未讀消息數量
            'untask' => 3,//未完成任務
        ), 
        'info' => 'Here is the message which, commonly used in popup window', //消息提示，客戶端常會用此做爲給彈窗信息。
        'code' => 200, //成功與失敗的代碼，通常都是正數或者負數
    );
    exit(json_encode($output));
} elseif ($a == 'get_games_result') {
    //...
    die('您正在調 get_games_result 接口!');
} elseif ($a == 'upload_avatars') {
    //....
    die('您正在調 upload_avatars 接口!');
}

 

點擊測試（對於客戶端而言，也是直接調用這樣的地址）：
http://www.xiuno.com/api/test/index.php
http://www.xiuno.com/api/test/index.php?a=get_users
http://www.xiuno.com/api/test/index.php?a=get_users&uid=10001
http://www.xiuno.com/api/test/index.php?a=get_users&uid=10002
http://www.xiuno.com/api/test/index.php?a=get_users&uid=10003

 

 

實際項目中，咱們在開發 API 應該注意的幾個事項（僅供參考）：

一、單文件實現多接口的形式有不少種，例如：if..elseif.. 或 switch 或 動態方法 (也就是xiuno的這種訪問函數體的形式)

二、對於數據的輸出最好用json，json具備至關強大的跨平臺性，市場上各大主流編程語言都支持json解析，json正在逐步取代xml，成爲網絡數據的通用格式

三、接口安全，必定要增長接口驗證。例如，客戶端和服務端針對不一樣接口統一作好加密方式，服務端在對於每次接口須要都要進行驗證。以保證防止接口被惡意刷新或黑客惡意調用，尤爲是大型商業應用。

四、對於線上的 API 必須保證全部接口正常且關閉全部的錯誤信息 => error_reporting(0)，在輸出JSON 時，不能有任何其它輸出，不然，客戶端將解析數據失敗，直接 Crash！

五、開發 API 和 WEB 有必定的區別，若是是 WEB 的話，可能代碼出錯了，不會致使特別嚴重的錯誤，也許只是致使數據寫入和查詢失敗，也許致使 WEB 的某個部分錯位或亂碼。但若是是 API，直接 Crash！

六、作接口開發，不建議使用框架開發，緣由歸納:  客戶端通常對服務端的響應速度有極高要求，所以，使用最原生態的 PHP 完成接口開發，是最高效的，假如用到了框架，還須要加載各類不須要多餘的文件.

說到這，不得不說扯一下，騰訊微博淘寶等開放平臺。其實那些開放平臺，所謂的開放，就是給你提供一個這樣的接口，你根據他們提供的技術文檔，按他們制定的格式和要求，調它們提供的接口文件（通常都是返回JSON或者XML），你就能夠獲取到他們的相關信息，

例如：QQ用戶基本信息、淘寶店鋪、商品消息等等。而後在根據這些消息，在你的應用裏完成交互。　　其實，ajax 也是調用 API 的一種體現形式，你以爲呢？