Android接口开发规范

1.返回格式

类别	参数类型	说明
code	int	响应码
data	object {} 或 List []	数据返回格式
message	string	消息提示内容

例：

{
  "code": 0,  //响应码
  "data": "object",   ///返回数据格式( object{} || List[] )
  "message":message //消息提示
}

注 : 不能返回为 null

(1).类型字段返回格式

..._type 返回字段
..._type_id 返回字段ID

{
 "public_personnel_housing_type" : "人员住房类型",
 "public_personnel_housing_type_id" : "人员住房类型ID",
}

(2).List<data> 列表数据格式

字段	数据类型	说明
page	int	第几页
limit	int	每页加载数量
search	string	搜索查找
type	int	类别查询(多种查询)
sort	int	排序查找(时间排序,字母排序,日期排序)

2.请求格式

类别	格式
请求地址	URL
请求格式	JSON
请求方式	POST
登录验证	TOKEN

(1). 路径规则

https://域名/路径/模块名/路径名（） + (add | delete | alter | info)

例: https://api.test.com/.../module/Interface + (add | delete | alter | info)

3.接口模块命名

类别	字段
增	模块名 + add
删	模块名 + delete
改	模块名 + alter
查	模块名 + info

4.列表接口

注 : 列表与详情不能为同一个接口