3

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

谢谢

4

3 回答 3

0

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

于 2012-09-07T12:05:47.597 回答
0

您应该按照其描述遵循HTTP 状态代码。最好让所有 REST 失败/错误响应具有一些常见字段，例如errorCode描述errorMessage您发回的状态。

{
    "apiStatus":{        
        "errorCode":"validation.error.invalidId",
        "errorMessage":"The Id entered is not valid"
    }
    "yourContentIfany": ....
}
于 2012-09-10T16:11:48.837 回答
0

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

于 2012-09-07T10:47:18.840 回答