错误管理

我们都知道,请求部分是重要的,但是从表面来看,它不是非常有用的。理想情况,我们应该提供一些为什么请求失败的细节。例如,一个请求包含了无效的参数值,或者是请求者没有被授权执行操作。

错误处理对于设计一个健壮且文档化的API来说时非常重要的方面。由于大多数RESTful Web服务被访问时通过HTTP/HTTPS,因此我们可以借助HTTP状态码来分类错误,并提供提示请求错在哪里。

注意

举个例子,如果一个操作不被允许,那么服务器应该返回403 HTTP错误码,或者是如果请求参数无效,应该返回400 HTTP错误码。除了HTTP响应码之外,API的开发也许希望在响应中提供他们自己的错误码,来给服务的消费者请求失败原因的更多提示。为了推进于此,我们可以修改我们建议的封装格式来包含错误属性: ```json { "status": "ERROR", "data": null, "error": { "errorCode": 999, "description": "Email address is invalid" } }

在这个例子中,这个操作没有完成,应该是因为传递了无效的电子邮箱地址。响应中包含了一个错误属性,表明应用层面的错误代码和描述。

results matching ""

    No results matching ""