rest - REST API 是否应该返回 UI 友好的错误消息？

Question

今天我和我的一位同事讨论了 REST API Schema，在这种情况下，消费者将是一个移动应用程序（android 和 iOS）。在讨论过程中，我的同事提出了一个要求，即 API 应该返回一个移动用户友好的错误消息，并且还支持多语言。

这是我提出的。

对于后端错误，例如 400

{
  "errors":[
    {

      "username": "Invalid username",
      "code": 453
    }
  ]
}

他的建议是通过多语言支持返回更人性化/应用程序友好的错误消息：

{
  "errors":[
    {

      "username": "Entered username is incorrect, please try again",
      "code": 453
    }
  ]
}

现在我对此的看法是，这将使 REST API 与移动应用程序紧密耦合。理想情况下，翻译和可读的错误消息需要在移动应用程序本身中处理。

经过大量的来回讨论，我想向开发社区询问这个问题，应该采取什么方法？

score 0 · Accepted Answer

我认为每个 api 都应该提供合理的、格式良好的错误消息。有什么替代方法，在出现错误时进行多次检查。

我见过他们使用数字作为不同类型错误代码的地方。然后，前端必须在每次发出返回错误的请求时进行检查。然后，这会导致在多个应用程序中实现类似的逻辑，这些应用程序都与同一端点进行通信。

至于声称后端与消费者紧密耦合，

{
  "errors":[
    {

      "username": "Entered username is incorrect",
      "code": 453
    }
  ]
}

更好，并且不与任何消费者捆绑在一起。

1 回答 1