:::info API 错误返回时,会返回错误码,错误码的定义是有规范的。 :::

错误码规范

错误码为 5 位数字。

1 (第 1 位) 01 (第 2 位和第 3 位) 01 (第 4 位和第 5 位)
服务级错误码 模块级错误码 具体错误码
  • 服务级错误码:1 位数进行表示,比如 1 为系统级错误;2 为普通错误,通常是由用户非法操作引起。
  • 模块级错误码:2 位数进行表示,比如 01 为用户模块;02 为订单模块。
  • 具体错的误码:2 位数进行表示,比如 01 为手机号不合法;02 为验证码输入错误。

    错误码定义

    错误码,定义在 ./internal/code/code.go 文件中。
    错误码的中文描述,定义在 ./internal/code/zh-cn.go 文件中。
    错误码的英文描述,定义在 ./internal/code/en-us.go 文件中。
    具体示例可参见源代码。