# README
统一API错误处理规则
- 服务级错误码需在
internal/pkg/code
包中进行定义。
错误码为 5 位数
1 | 01 | 01 |
---|---|---|
服务级错误码 | 模块级错误码 | 具体错误码 |
- 服务级错误码:1 位数进行表示,比如 1 为系统级错误;2 为服务级错误,由服务级错误码定义
- 模块级错误码:2 位数进行表示,比如 01 为用户模块;02 为订单模块。
- 具体的错误码:2 位数进行表示,比如 01 为手机号不合法;02 为验证码输入错误。
统一API返回规范:
{
"code": 0,
"message": "success",
"data": {}
}
# Functions
NewError 新建一个 Error.
NewErrorAutoMsg 新建Error,msg自动从错误码注册表中获取.
NewErrorWithStatusOk 新建 Error,httpCode 默认为 http.StatusOK.
NewErrorWithStatusOkAutoMsg 新建Error,httpCode 默认为 http.StatusOK,msg自动从错误码注册表中获取.
NewResponse 新建一个 JsonResponse 此函数保证 JsonResponse.Data 不为 nil.
Text 注册表转换.
# Constants
系统级错误码定义.
系统级错误码定义.
系统级错误码定义.
系统级错误码定义.
系统级错误码定义.
# Structs
JsonResponse HTTP 服务常用的返回结构.
# Interfaces
Error 封装返回错误(HTTP状态码+自定状态码+返回错误信息堆栈).