REST API 响应的正确方法是什么？

Question

REST API 响应结构和布局的最佳实践是什么？

刮伤的例子：

成功回复：

{
    "status": "success",
    "data": # some data here
}

失败响应：

{
    "status": "fail",
    "data": {
        "code": # some error code,
        "message": # some error explaining message
    }
}

Answer 1

有很多方法可以设计您的 API 响应。它以您的架构、技术和其他方面为条件。

根据你的例子，我会这样回应

请求成功：

{
    "status": "success",
    "data": {
            /* Application-specific data would go here. */
    },
    "message": null /* Or optional success message */
}

失败的请求：

{
    "status": "error",
    "code": 404,
    "data": null, /* or optional error payload */
    "message": "Error xyz has occurred"
}

有关此主题的更多信息，请查看此链接

标准的 JSON API 响应格式？

设计实用 RESTful API 的最佳实践

REST API 错误代码 101