Question

我最近一直在编写Web服务，这是一个示例成功和错误响应。

错误

{
  "code": 1150,
  "status": false,
  "message": "API Student does not exist.",
  "serverTime": "2013-11-29 09:47:52"
}

成功

{
  "code": 200,
  "status": true,
  "data": {
    "id": 49
  },
  "serverTime": "2014-04-17 05:06:17"
}

关于返回错误，我有一个困惑，为什么我们总是返回一个错误代码和一条消息，例如，当需要用户名和密码作为输入参数时，说出一个空白请求，所以我返回的是错误代码1100 和错误消息＆＃34;用户名不正确＆＃34; 。我从不返回整个错误列表，例如，在这种情况下，应该发送带有两个错误代码的两条错误消息，以便保存最终用户数据和数据。时间。

这是我建议的样本吗？

{
  "code": 1010,
  "status": false,
  "errors": [
    {
      "code": 1000,
      "name": "Username invalid"
    },
    {
      "code": 1001,
      "name": "Password invalid"
    },
        {
      "code": 1002,
      "name": "Password not strong"
    }
  ],
  "serverTime": "2013-12-03 12:34:02"
}

为什么这不是一个好方法呢？我没有在Twitter API或Facebook API中看到过这个。

Answer 1

没有人可以阻止API设计者返回多个可能的错误响应。 决定只取决于他们，但在我看来，您应该返回服务器端发生的最相关错误。

背后可能有很多原因如下：

所有客户端的统一错误处理。

引起的最相关错误将更有助于客户，因为他不必关心所造成的所有概率错误。

JSON结构简单。（将避免使用错误数组。）

REST API JSON错误代码和错误消息

1 个答案: