REST API的标准成功，失败和错误JSON响应格式应该是什么？

Question

返回成功JSON，失败JSON和错误JSON的标准格式应该是什么？我访问了许多所谓的RESTful API，但几乎所有人都有自己的方式来返回成功，失败和错误JSON？是否有任何应该遵循/引用的推荐JSON格式？

由于

Answer 1

好问题。 REST确实设置了一些约定，但与GET或PUT HTML不同，其中至少有一个标签名称要发送的约定，几乎没有用于JSON的词汇......我相信任何真正有用的长期用法需要开发超出基本事务行为的正式词汇表，无论是HTML，XMPP还是JSON方言（例如，在XMPP中，与单独的WebSockets不同，您可以开发知道如何处理任何Pubsub服务器的订阅和发布的客户端）

Answer 2

要表示成功，错误或任何其他状态，您应使用标准的http状态代码。 如果出现错误，您还可以返回包含代码，严重性和消息等内容的json。

Answer 3

您应按照其描述遵循HTTP Status Codes。让所有REST失败/错误响应都有一些常见字段，如errorCode和errorMessage，这些字段描述了您要发回的状态。

{
    "apiStatus":{        
        "errorCode":"validation.error.invalidId",
        "errorMessage":"The Id entered is not valid"
    }
    "yourContentIfany": ....
}