罗盘开放平台
作为对外开放的入口,对内通过rpc接入业务
采用YAR扩展实现RPC通讯:内网通讯快速通道,特点高效、稳定
目标:jos.jd.com
开放平台主要分四部分
1、网关(鉴权、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": "操作成功"
}
2、开发者后台(应用管理、开发者资料) dev.xslp.cn
3、文档(接口文档、在线测试、sdk下载) dev.xslp.cn
4、接口管理(接口参数配置、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 测试状态码
*/
注意:
1、参数类型:
text
file
json
int
float
double
date
datetime
boolean
byte
short
long
2、状态码分配
http://t-passport.xslp.cn/index.php?m=service&c=v10Test
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