API開發(fā)

ApiAdmin支持在其基礎(chǔ)上直接二次開發(fā)Api，這篇文章將詳細(xì)的說明Api開發(fā)的步驟。

聲明

• 默認(rèn)的域名為：http://localhost
• 服務(wù)器后臺(tái)為：http://localhost/Admin/
• 服務(wù)器環(huán)境為：Nginx + MySQL + PHP5.6

新增接口

要想讓接口被系統(tǒng)接受，我們需要在后臺(tái)添加接口。所有的接口訪問都必須根據(jù)系統(tǒng)自動(dòng)給出的hash來請(qǐng)求

請(qǐng)求參數(shù)

當(dāng)關(guān)閉了測(cè)試的時(shí)候，ApiAdmin會(huì)根據(jù)請(qǐng)求參數(shù)過濾用戶的輸入?yún)?shù)，所以，如果不配置請(qǐng)求參數(shù)，那么你會(huì)獲取不到任何請(qǐng)求參數(shù)。

返回參數(shù)

系統(tǒng)不會(huì)過濾返回參數(shù)，所以開發(fā)者在做數(shù)據(jù)返回的時(shí)候一定要處理好字段，但是系統(tǒng)會(huì)自動(dòng)處理返回的參數(shù)的字符類型。不過一定要配置好返回參數(shù)。

返回參數(shù)的配置相對(duì)較為簡(jiǎn)單，只需要將返回的數(shù)據(jù)上傳即可！

完成數(shù)據(jù)上傳，系統(tǒng)會(huì)自動(dòng)判斷數(shù)據(jù)類型以及字段層級(jí)，但是有以下幾點(diǎn)需要注意：

• 在配置接口參數(shù)的時(shí)候，連接口都沒有，怎么會(huì)有返回?cái)?shù)據(jù)？對(duì)于這個(gè)先有雞還是先有蛋的問題，不做討論，建議開發(fā)接口的時(shí)候?qū)y(cè)試模式打開，然后開發(fā)完成，獲取到數(shù)據(jù)的時(shí)候再提交。
• 系統(tǒng)自動(dòng)判斷數(shù)據(jù)類型， 對(duì)于手機(jī)號(hào)碼類型的判斷有錯(cuò)誤，應(yīng)該是String類型，系統(tǒng)給出的是Integer類型，需要手動(dòng)修改。
• 如果想要讓Api文檔變的更加豐滿，需要單獨(dú)配置字段說明（一個(gè)個(gè)配置哦）。
• 如果修改返回字段的時(shí)候，只能通過上傳來覆蓋原先的配置，系統(tǒng)會(huì)自動(dòng)將字段名稱（字段名和字段層級(jí)）一樣的，不做變更，但是把不存在的字段名刪去，同時(shí)新增多出來的字段。

開始寫代碼

前幾步的配置，基本保證了API的接入，下面將是對(duì)API邏輯的處理，打開項(xiàng)目代碼找到/Application/Home/Api/，接下來Api邏輯將寫在這里。

接下來我們將以獲取AccessToken為例來闡述API的編寫方法。

1. 創(chuàng)建BuildToken.class.php，必須嚴(yán)格注意大小寫，同時(shí)得帶上.class。
2. 編寫代碼邏輯。

   
   <?php
   /**
   * 和Token相關(guān)的全部接口
   * @since   2017/03/02 創(chuàng)建
   * @author  zhaoxiang <zhaoxiang051405@gmail.com>
   */
   namespace Home\Api;
   use Admin\Model\ApiAppModel;
   use Home\ORG\ApiLog;
   use Home\ORG\Crypt;
   use Home\ORG\Response;
   use Home\ORG\ReturnCode;
   class BuildToken extends Base {
   public function getAccessToken($param) {
       if (empty($param['app_id'])) {
           Response::error(ReturnCode::EMPTY_PARAMS, '缺少app_id');
       }
       $appObj = new ApiAppModel();
       $appInfo = $appObj->where(array('app_id' => $param['app_id'], 'app_status' => 1))->find();
       if (empty($appInfo)) {
           Response::error(ReturnCode::INVALID, '應(yīng)用ID非法');
       }
       $crypt = new Crypt();
       $signature = $param['signature'];
       unset($param['signature']);
       $sign = $crypt->getAuthToken($appInfo['app_secret'], $param);
       Response::debug($sign);
       if ($sign !== $signature) {
           Response::error(ReturnCode::INVALID, '身份令牌驗(yàn)證失敗');
       }
       $expires = C('ACCESS_TOKEN_EXPIRES');
       $accessToken = S($param['device_id']);
       if ($accessToken) {
           S($accessToken, null);
           S($param['device_id'], null);
       }
       $accessToken = $crypt->getAccessToken($appInfo['app_id'], $appInfo['app_secret']);
       $appInfo['device_id'] = $param['device_id'];
       ApiLog::setAppInfo($appInfo);
       S($accessToken, $appInfo, $expires);
       S($param['device_id'], $accessToken, $expires);
       $return['access_token'] = $accessToken;
       $return['expires_in'] = $expires;

return $return; } }

> 注意：上面我們?cè)谛略鼋涌诘臅r(shí)候，填寫的接口名稱為`BuildToken/getAccessToken`，所以現(xiàn)在的類名稱必須為`BuildToken`，而方法名稱必須為`getAccessToken`。


代碼中有幾點(diǎn)需要說明：
- `public function getAccessToken($param)`，這里的`$param`就是一個(gè)參數(shù)名稱，你可以任意命名，同時(shí)`$param`是系統(tǒng)處理過的用戶輸入?yún)?shù)。
- 當(dāng)你處理完邏輯，直接`return`數(shù)組就好了，系統(tǒng)會(huì)自動(dòng)捕獲你返回的數(shù)組，并且做后期處理。


### 最后說明
到這里，獲取AccessToken的接口就全部開發(fā)完成了，還有幾點(diǎn)需要闡明：
1. 錯(cuò)誤輸出使用Response::error();
2. 請(qǐng)使用PostMan測(cè)試接口，明確Header參數(shù)和GET/POST參數(shù)。
3. 請(qǐng)查看http://localhost/wikiList.html獲取API文檔。
4. 請(qǐng)查看http://localhost/calculation.html獲取身份令牌計(jì)算算法。
5. 請(qǐng)查看http://localhost/errorList.html獲取錯(cuò)誤碼細(xì)節(jié)。