json - Rest API中成功和错误响应的详细信息

Question

我在节点js中编写一个REST API，并使用mssql作为我的数据库。我对于api应该按照休息准则返回的成功和错误响应的细节感到困惑。例如，如果执行数据库操作时键约束出现错误，则错误消息应如下所示
{
"error": {
"code": 500,
"message": "Internal Server Error"
}
}还是需要更详细地说明错误详细信息(例如表详细信息)。通过错误放弃内部细节是否正确？状态代码是否需要成为json对象的一部分？另外，成功消息是否应该更通用，例如带有200个代码的“成功创建记录”或更具体？

Answer 1

始终考虑最终用户。如果返回完整的错误消息，它将对他有帮助吗？可能用户执行了错误的请求，导致内部失败。如果没有，将其清除为并记录错误!

例如，当用户收到此响应时，他应该重复该请求吗？还是服务器故障，应该等待修复？因此，我建议类似:

{
  "error": {
  "code": 1000,
  "href": 'http://mywikiapage.com/errors/1000',
  "message": "Sorry, we're experiencing some issues. Try again later."
   }
}

请注意，错误代码已更改。它的新“自定义”代码可以引用Wiki页面，其中提供了有关错误本身的更多详细信息。此外，用户始终可以从HTTP响应中获取500个结果代码。

我也建议阅读 this other SO question