如何设计接口

请求:

{
    "header":{
        "version":"1.0.0",
        "pageIndx":1,
        "pageSize":20,
        "client":"and/iOS/web"
    },
    "body":{}
}

header:通常须要区分app使用的版本、客户端的来源,更多关于客户端的统计都放到header部分中
body:部分用于业务数据的存放,这样对于业务数据没有过多的影响,层次分别web

返回:

{
    "code":"101",
    "msg":"获取成功",
    "array":[],
    "obj":{},
    "pageIndx":1,
    "pageSize":20,
    "totalPage":8
}

code:后台返回的状态码(通常成功操做为0或000)
msg:后台的操做提示(客户端可直接使用该提示语句)
array:存放一些可用于展现分页的数据
obj:存放其余数据(如:分类信息)
pageIndx:当前分页Index
pageSize:当前分页数据大小
totalPage:共多少页json

相关文章
相关标签/搜索