一、错误规范
当接口出现非2xx、3xx的HTTP响应时,采用返回统一HTTP响应信息:
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"code": "INVALID_ARGUMENT",
"message": "{error message}",
"request_id": "01234567-89ab-cdef-0123-456789abcdef",
"host_id": "{server identity}",
"server_time": "2014-01-01T12:00:00Z"
}
错误信息结构
错误规范中包含 3 个层级的信息
┗ http status code
┗ code
┗ message
- http status code
符合 HTTP 协议的响应状态码
- code
用来表示某类的错误,如缺少参数、类型不匹配等等,用来对 http status code 进行扩展,开发人员可以据此进行错误的细节处理。详见#code
- message
为错误的摘要信息,并且应该包含对用户处理该错误有指导意义的信息
作者:网教通 创建时间:2023-10-08 10:41
更新时间:2023-11-14 11:11
更新时间:2023-11-14 11:11