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

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

scrath的例子:

成功回应

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

失败响应

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

有很多方法可以设计您的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

链接地址: http://www.djcxy.com/p/48077.html

上一篇: What is a right way for REST API response?

下一篇: Better JSON parsing implementation in Objective