php - 大家一般怎么规范接口返回内容

Question

一般后端返回的的内容有 返回码、数组、提示信息
大家一般怎么命名
还有就是一般整个返回的数组json一次，还是说不只一层json

Answer 1

参考如下

{
    Status: 1, //数据状态
    Code: 200, //反码状态
    Message: 'Successful', //描述信息
    ClientTime: 1473765898, //客户端请求时间
    ServerTime: 1473765935, //服务端响应时间
    token: '38ce6474a370c3fe84ddf92403bec204cfcbe07b', //唯一token也可做加密key
    data:{ //json数据，格式层级关系根据对应需求虽易定
        key1: value1,
        key2: value2,
        key3: {
        [
            name: '小明',
            sex: 1,
        ],[
            name: '小华',
            sex: 1,
        ],[
            name: '小刚',
            sex: 1,
        ]}
    }
}

Answer 2

errNo=>
errMsg=>
data=>

然后json_encode这个数组

Answer 3

{
    code：200,
    message: "success",
    data: { key1: value1, key2: value2, ... }
}

code: 错误码
message: 描述信息，成功时为"success"，错误时则是错误信息
data: 成功时返回的数据，类型为对象或数组

Answer 4

成功时：

{
    "code":“200”,
    "data":“成功返回数据，如果没有数据返回空数组形式[]”
}

出错时：

{
    "code":"错误码",
    "msg":"错误提示"
}

Answer 5

API数据给客户端使用时最忌讳字段的变动，最好遵循只增不减的原则,另外返回格式最好全是字符串，在客户端再进行转换处理，另外要注意的是千万不能有NULL值的存在(指iOS与Andorid中使用时),为NULL时最好给 " " (双引号的空),还有就是JSON的层次最浅越好方便客户端解析 。
一般情况下最简单的返回方法就是:

{
    "status" : 0,
    "msg"    : "...",
    "data"   : [...]
}
// status 0 代表失败 1代表成功  msg 带传递的一些文字信息(失败时有用) data 一般用数组 数据PUSH进数据即可。 

ps: header里还要规定 Content-type : application/json;charset=utf-8
:)

Answer 6

写个interface并且实现tojson

Answer 7

我觉得没有什么具体的规范形式吧，具体得看实际业务。虽然json是主流，但是也有返回xml的啊。。命名更没什么说的了。