通用数据结构

在进行接口对接的时候,存在一套标准的数据结构,会让对接事半功倍,那么我们主要从几个通用的数据结构进行说明。

通用响应结构

若使用了自定义的一套状态码进行交互时,需要定义一个通用的响应结构,例如:

{
    "code": 0, // 0表示处理成功,-1表示处理失败,诸如此类,可能还有更多的code代表不同的情况
    "data": "hello world", // 结果数据
    "message": "success" // 成功或错误的信息
}
通用列表结构

通常列表数据有一定的特点,为数组结构,并且大多包含分页信息,那么我们分别从包含分页及不包含分页来说明。

// 无分页
{
    "code": 0,
    "data": [
        {"id":1, "name":"name1"},
        {"id":2, "name":"name2"},
        {"id":3, "name":"name3"}
    ],
    "message": "success"
}

// 有分页,pagination参数直接与antd对应,开发起来较为方便统一,无需映射
{
    "code": 0,
    "data": {
        "list": [
            {"id":1, "name":"name1"},
            {"id":2, "name":"name2"},
            {"id":3, "name":"name3"}
        ],
        "pagination": {
            "current": 1, // 当前页数
            "pageSize": 10, // 每页条数
            "total": 3 // 数据总数
        }
    },
    "message": "success"
}
Copyright © zhengxiangqi 2018 all right reserved,powered by Gitbook该文件修订时间: 2019-09-30 02:14:29

results matching ""

    No results matching ""