羅盤開放平臺設計

羅盤開放平臺

 

做爲對外開放的入口，對內經過rpc接入業務

採用YAR擴展實現RPC通信：內網通信快速通道，特色高效、穩定

目標：jos.jd.com

 

 

開放平臺主要分四部分

一、網關（鑑權、rpc路由、auth受權）open.xslp.cn

接入規則跟原來的通行證一致（http://121.199.34.178/redmine/projects/cm/wiki/Xslpauthbind）

返回格式{

    "code": "1",

    "data": {

        "id": "12",

        "username": "company@company.com",

        "app_key": "100",

        "email": "123@qq.com",

        "login": "167",

        "realname": "燕俊bb0"

}

    "msg": "操做成功"

}

二、開發者後臺（應用管理、開發者資料） dev.xslp.cn

三、文檔（接口文檔、在線測試、sdk下載） dev.xslp.cn

四、接口管理（接口參數配置、rpc參數和狀態碼抓取、在線測試）manage.open.xslp.cn

地址：http://192.168.1.100:3000/#!/home/project/api

系統自動抓取rpc的註釋文檔，提取參數和狀態碼，下面是約定的註釋格式

 

接口方法：

pp.test.add

服務名稱：

  PP.Service.V10.Test.add

解釋：

PP:對應平臺（PP|CL|SL|TCP|PM|PL）

Service：模塊

V10：目錄(修改thinkphp代碼)

Test：控制器

add：函數

 

系統級參數：

USERID、CORPID、APPKEY

網關隱式傳遞

如：public function test($client_id,$client_name,$USERID,$CORPID,$APPKEY)

第三方調用Api只須要提交$client_id,$client_name這三個參數

 

 

 

 

 

 

rpc函數註釋格式約定

  /**

     * 公告回收站完全刪除

     *

     * @param int $key null 主尺寸鍵

     * @param int $userid  notnull  刪除人id

     * @return array（{'':''}）

     *

     * @code 100002 測試狀態碼

     */

 

 

 

 

 

注意：

 

一、參數類型：

text

file

json

int

float

double

date

datetime

boolean

byte

short

long

 

 

二、狀態碼分配

 

http://t-passport.xslp.cn/index.php?m=service&c=v10\Test

 

00000 - 00999 通行證

01000 – 01999 消息中心

03000-09999  （未知應用）

02000-02999 網關

 

10000 - 19999 SL

20000 - 29999 CL

30000 – 39999 PL

40000 - 43999 SLT

44000 - 46999 CLT

47000 – 49999 PLT

50000 - 59999 TCP

60000 - 69999 POP

70000 - 79999 AMP