我怎样才能在Rest应用程序中通知API警告?

时间:2016-08-23 14:22:44

标签: rest http http-status-codes api-design

我试图找出如何与REST API的客户端进行警告的沟通。

我熟悉返回错误代码和使用http状态代码的做法。 Something like this

{
   "status": 400,
   "code": 4000,
   "message": "Provided data not sufficient for insertion",
   "developerMessage": "Please verify that the feed is properly generated/set"
}

互联网上有很多例子说明了开发人员如何处理响应错误。但他们都没有谈到这个"警告"情况下。

这是什么警告?

例如,当用户在我的系统上进行身份验证时,有时我的API需要通知用户他需要联系支持人员并在系统中执行某些操作之前确认一些信息。

另一种选择是阻止用户执行此特定操作,返回错误并暂时忘记此警告案例。但我认为,在另一种情况下,这将是必要的。

那么,这种情况的替代方案是什么?我可以使用什么http状态?如何区分错误和警告?

谢谢!

1 个答案:

答案 0 :(得分:1)

  

例如,当用户在我的系统上进行身份验证时,有时候是我的API   需要告知用户他需要联系支持人员   在系统中执行某些操作之前确认一些信息

您应该决定用户在访问特定资源之前是否必须确认某些信息。如果用户不会收到错误,则可以忽略验证。我将使用HTTP状态代码403 Forbidden - 用户可能已登录但没有资源(https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)的必要权限,并在消息中指定确切原因。相关讨论:HTTP status for "email not verified"