接口协议

接口协议

公共的接口协议

通信协议

采用标准 http1.1 协议

请求方法

不同的接口具体而定

公共参数

这里定义一些公共参数，公共参数统一放在 Http-Header 头里。

参数名	是否必须	类型	描述	备注
X-AL-Request-Id	是	string	请求唯一id,可用于日志和调用链追踪	可根据请求的时间纳秒数+随机数生成
X-AL-Platform	是	string	请求平台	0:未知 1:后台 2:H5
X-AL-Timestamp	是	int64	请求时间戳	unix 时间戳
X-AL-Login-Token	是	sting	用户登录后Token	用来校验登录态
X-AL-Sign	是	string	生成的签名	根据签名算法生成

接口签名

todo

返回格式

理论上我们一般用 json 来作为接口协议格式 同时接口也应该支持 jsonp 的返回格式

返回格式如下：

{
    "code": 10100,
    "tips": "弹出信息",
    "message": "具体的提示信息",
    "data": {}
}

字段解释

字段名	类型	描述	备注
code	int	返回错误码	code 为 0 标示成功，非 0 标示失败
tips	string	弹出信息	给用户的提示信息
message	string	具体的错误信息	成功 message 为空
data	object	返回的数据	无