在REST API中定义错误结构
REST API中错误结构的最佳实践是什么? 我知道我应该使用HTTP中的代码来描述它(REST API错误返回良好实践),但是结构总是有用的,并且我发现自己总是使用类似错误的类型和错误原因(引发CanNotCreate('Because of this')
)。
定义错误消息结构的最佳实践是什么? 你能举一个具有良好错误处理的特定API的例子吗?
我通常在响应状态的原因语句中指示'类型'(例如: 409 Cannot Create
而不是更典型的409 Conflict
),因为它是机器可分析的,无需解析HTML,XML或JSON等媒体类型。 通常,Reason-Phrase足以让机器客户端做适当的事情,特别是当给定的资源可能会以相同的原因返回相同的代码时。
然后,在响应主体中,将程序员和最终用户的更多信息包含在您在别处使用的相同媒体类型中; 例如,如果请求已成功并返回200 OK
,则返回带有错误响应的JSON。 否则真的会让人们对你的API开发感到沮丧。
最后,如果您的媒体类型允许,请尽可能在响应中包含超链接,以帮助客户解决问题。
链接地址: http://www.djcxy.com/p/45329.html