前后端接口通讯协议

owo

1.所有接口以下面的数据结构返回

{
    code: 200, // 200 表示成功, 其他表示失败, 具体失败类型由负责具体业务的开发约定
    data: {
        // 接口数据, 最好是对象格式, 即使返回值为 Number/String/Boolean/Array 等字面量, 最好也返回一个key:value, 结构, 避免前端处理异常
        id: 100, // 创建成功之后的对象ID
        total: 1000, // 分页总条数
        list: [], // 分页数据
        // ...
    }, 
    data: {
        registerSucceed: true, // Boolean 返回类型举例
    },
    data: {
        price: 1000, // Number 返回类型举例
    },
    data: {
        username: "xingbianli", // String 返回类型举例
    },
    data: {
        rackIds: [1, 2, 3, 4], // Array 返回类型举例
    },
    msg: '', // 提示消息, 如果 code 不是 200, 则该字段必须有值
    debugMessage: '' // 可选项, 后端可以在beta环境选择性输出详细的调试信息, 例如 StackTrace 等, 前端在beta环境可弹出详细调试信息, 加快调试进度.
}

2.查询分页数据:

Request: 
// URL: /query
{
    pageNum: 1, // 当前第几页, 从1开始
    pageLine: 20 // 每页数据条数
}
Response:
{
    code: 200,
    data: {
        count: 5000, // 总数据条数, 必须
        total: 10, // 总页数, 可选
        pageNum: 1, // 当前第几页, 从1开始, 可选
        pageLine: 20 // 每页数据条数, 可选
        list: [{
            id: 1,
            name: '猩便利',
            ...
        },
        ...
        ]
    },
    msg: ''
}

3.请求示例

新增数据
Request: 
// URL: /people/add
{
    name: '微猩便利',
    gender: 1,
    age: 30
}
Response:
{
    code: 200,
    data: {
        id: 21, // 关键数据需要返回
        name: '微猩便利', // 其他数据视使用情况约定需要的数据
        gender: 1,
        age: 30
    }
}
编辑数据(失败)
Request: 
// URL: /people/save
{
    id: 0,
    name: '猩便利',
    gender: 1,
    age: 30
}
Response:
{
    code: 400, 
    message: '更新失败, 请选择编辑对象'
}
编辑数据(成功)
// URL: /people/save
{
    id: 21,
    name: '猩便利',
    gender: 1,
    age: 30
}
Response:
{
    code: 200, 
    data: {
        name: '猩便利',
        gender: 1,
        age: 50
    }
}