json - 在 JSON Web 服务中发送错误响应的最佳实践是什么？

Question

在 JSON Web 服务中发送错误响应的最佳实践是什么？我已经看到它以多种方式完成，并想知道在这些选择中是否有任何商定的标准或最佳实践。

我已经看到它完成了，其中响应包括成功或失败的指示以及要返回的数据或合适的错误消息，例如

[{'success':true, 'data':{...}]
[{'success':false, 'data':{'message':'error'}]

但我也见过一些示例，其中 JSON 对象仅包含数据，并且服务使用正常的 HTTP 错误代码来指示问题(403、404、500 等)。 (Twitter API 就是这样做的。)

有没有“正确”的方法来做到这一点，还是只是风格问题？后一种方法更“RESTful”吗？

Answer 1

在“RESTful”方法中，主要错误响应由适当的状态代码 (4xx/5xx) 指示。

您的消息应提供有关如何从错误中恢复的附加的、特定于应用程序的提示。这可能包括已发生错误的人类可读表示或某种更具技术性的指标(即提供异常类名称)。

为了通用，请保留错误消息的修复语法。这允许您在不破坏客户端的情况下引入新的错误消息。