安全

使用双重RSA密钥验证,平台双方都有对应的密钥对, 将私钥发给对方, 发送方 对请求体按照字母顺序排序成字符串,AES进行字符串加密, 使用私钥进行签名, 接收方 使用公钥进行签名校验。 校验通过后再进行对应处理。

统一的请求,返回格式

所有的API接口都必须 返回相同的数据格式,

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{

code:``200``,` `// 非200代码 为 错误码

data: {

users: [],

user: {}

}

msg:"" // 当非200代码时, 提示错误信息

}

幂等(可重入)

API接口相同的请求体, 不同时间请求多次, 返回的数据应该一致, 如: 入件接口,返回入件成功, 入件失败, 不会从失败变成成功。

文档

可读性, 历史可追溯, 推荐使用石墨文档markdown进行文档生成, markdown文件使用git进行版本管理。