通常情况下,API在遇到业务问题时应该返回错误的HTTP响应码。对于大多数Web API,常见的错误响应码如下:
在返回这些错误码时,API可以提供有用的错误信息,以帮助客户端诊断问题。一种常见的方法是,响应体中包含JSON对象,其中包含一个“message”字段,说明错误的原因。例如:
HTTP/1.1 400 Bad Request Content-Type: application/json
{ "message": "Invalid request parameter: 'start_date'" }
当然,并不是所有业务问题都可以归类为错误响应。在某些情况下,需要返回非错误的HTTP响应码,以及附加的响应数据说明成功的结果。一个例子是GET请求,请求一个资源的详细信息,但如果资源不存在,应该返回404错误。但是,如果是列表请求,没有匹配到任何匹配的资源,则返回一个空列表,而不是错误。例如:
HTTP/1.1 200 OK Content-Type: application/json
[]
上一篇:api接口域名
下一篇:API解码结构体Swift