一、错误规范

当接口出现非2xx、3xx的HTTP响应时,采用返回统一HTTP响应信息:

  1. HTTP/1.1 400 Bad Request
  2. Content-Type: application/json
  3. {
  4. "code": "INVALID_ARGUMENT",
  5. "message": "{error message}",
  6. "request_id": "01234567-89ab-cdef-0123-456789abcdef",
  7. "host_id": "{server identity}",
  8. "server_time": "2014-01-01T12:00:00Z"
  9. }

错误信息结构
错误规范中包含 3 个层级的信息

  1. http status code
  2. code
  3. message
  • http status code

符合 HTTP 协议的响应状态码

  • code

用来表示某类的错误,如缺少参数、类型不匹配等等,用来对 http status code 进行扩展,开发人员可以据此进行错误的细节处理。详见#code

  • message

为错误的摘要信息,并且应该包含对用户处理该错误有指导意义的信息

作者:网教通  创建时间:2019-08-30 21:12
 更新时间:2023-11-14 10:57