Question

我正在开发一个Web API，它会因多种原因返回Forbidden http状态 -

用户被阻止。
IP被阻止。
超出了请求限制。
用户未经验证。

我将以下列方式回复 -

return Content(HttpStatusCode.Forbidden, message);    //message : "Limit reached" etc.

现在，我需要在客户端以不同的方式处理这些原因。我应该从退回的消息中找出原因吗？此消息将显示给用户，并可能在将来更改。

最佳做法是什么？

Answer 1

您的错误消息应该是您客户的描述。理想情况下，您需要包含以下信息：

开发者留言（技术说明 - ＆＃34; cache is out-of-date＆＃34;，＆＃34; service A is unavailable＆＃34;）
人类可读的讯息（业务说明 - ＆＃34; this time is booked already＆＃34;，＆＃34; company A is closed and cannot be modified＆＃34;）
提示如何解决（＆＃34; refresh your cache＆＃34;，＆＃34; try again in 5 minutes＆＃34;，＆＃34; request permission A from administrator＆＃34;）
href到您的在线文档
标题为＆＃34; error_code: 100＆＃34;。还应在文档中描述自定义代码。您可以依赖客户的代码并妥善处理

你的意思是：

用户未经验证。

如果用户未经过身份验证（api不知道谁是他），api应该返回401 http状态代码。如果用户缺少某些权限，因此无法修改资源，403完全正常。但是，描述哪些权限确实缺失会很棒

Answer 2

最佳做法是什么？

您应该寻找标准化的内容，例如Problem Details for HTTP APIs，而不是尝试发明自己的模式。

问题详情描述了一个人类可读的标题＆＃34;和＆＃34;细节＆＃34;字段和＆＃34;类型＆＃34;这是人类可读文档的链接。

消费者必须使用＆＃34;类型＆＃34; string作为问题类型的主要标识符; ＆＃34;标题＆＃34; string是建议性的，仅包括那些不了解URI语义且无法发现它们的用户（例如，离线日志分析）。消费者不应自动取消引用类型URI。

消费者不应该解析＆＃34;细节＆＃34;信息成员; extensions更适合获取此类信息且不易出错的方式。

区分来自web api的相同状态代码中的消息

2 个答案: