经验分享-API接口响应格式规范定义

俗话说无规矩不成方圆，一个接口一种数据响应格式，一个开发人员一种开发格式，导致代码不规范，数据解析复杂化，维护更是难上加难。

1.关于接口响应数据格式参考[json格式],做到不使用的属性不返回

基础响应格式【其他格式在此格式上进行扩展】

{
    "code":100,
    "msg":"ok",
}

对象格式【对象数据存在】【对象数据不存在，使用基础响应格式】

e:个人信息为例

{
    "code":100,
    "msg":"ok",
    "data":{
        "id":100,
        "name":"小伟",
        "age":20,
        "sex":0
    }
}

数组格式【数组可以对象数组，字符数组】【数组不存在，使用基础响应格式】

{
    "code":100,
    "msg":"ok",
    "data":[
            {
                "id":1,
                "name":"小王",
                "age":10
            },
            {
                "id":1,
                "name":"小王",
                "age":10
            }
        ]
}

分页列表格式【分页结果】【分页数据不存在，使用基础响应格式】

{
    "code":100,
    "msg":"ok",
    "data":{
        "nowPage":1,
        "totalPage":10,
        "list":[
            {
                "id":1,
                "name":"小王",
                "age":10
            },
            {
                "id":1,
                "name":"小王",
                "age":10
            }
        ]
    }
}

按照以上的划分，是可归为一类型对象类型，data可以为是数组，自定义对象，分页对象,使用Java作为开发语言，可以直接定义一个请求响应泛型类，

e:基础解析类

public class ReqBase {

    /**响应码*/
    public int code;
    
    /**响应码相关提示信息*/
    public int msg;
    
}

对象响应泛型类型

public class ReqObjectT<T> extends  ReqBase{

    /**数据*/
    public T data;
}

接口响应数据格式中，图片地址必须给出完整的地址

e:{
    "code":100,
    "msg":"ok",
    "data":[
        "http://xxx/file/upliad/20172514.jpg",
        "http://xxx/file/upliad/20172515.jpg"
    ]
}