服务器端API接口开发规范
关于HTTP请求
通信安全
服务器与客户端在交换数据前,对数据签名后(使用私钥进行非对称加密)再进行传输,任何一方收到数据,需要签名效验(使用公钥进行解密),只有签名效验通过后才做业务逻辑处理。
API请求规则
- 采用不同的 HTTP-METHOD 对服务器资源进行操作
GET api/user
获取用户列表GET api/user/1
获取用户id=1的对象POST api/user
创建新用户PUT api/user/1
更新用户id=1的对象DELETE api/user/1
删除用户id=1的对象
- 数据分页
GET api/user?page=1&size=20
获取部分用户列表,参数page表示第一页,参数size表示每页20个数据
- 数据字段
GET api/user?fields=name,age
选取部分用户字段,参数fields表示选取字段并用逗号隔开
- 数据排序
GET api/user?sort=age&sm=dsc
对指定字段进行排序,参数sort表示排序字段,参数sm表示排序方式(升序asc/降序dsc)
- 数据查询
GET api/user?query=name-like-bosch;
对指定多字段进行查询并获取结果集(模糊like/范围rang/指定equal),用分号隔开多条件。name-查询字段,like-查询方式,bosch-查询内容
客户端数据请求
客户端与服务器都采用json数据结构来通信,例如客户端创建用户发送以下数据:
POST api/user
服务器端数据返回
处理成功返回结构:
处理失败返回结构:
errcode=0表示服务器处理正常,非0表示处理异常。