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"
}

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

Standard JSON API response format?

Best Practices for Designing a Pragmatic RESTful API

REST API Error Codes 101