教你怎么给接口定义错误码

错误码一般包括三个要素：

• 前缀标识：区分错误类型，比如请求不合法，还是服务器处理错误。
• 模块标识：区分到底是哪个模块的错误。
• 错误代码：区分具体是什么问题。

从错误码的符号组成上看又分为三类：

• 纯数字
• 数字+字母组合
• 纯字母

按照使用的分隔符的不同，又有：

• 无分隔符，按照数字的位数分割
• 使用"-"分割
• 使用"_"分割
• 使用"."分割

接下来介绍三种常用的错误码的规则。

纯数字-无分隔符，企业微信的开放接口就是这种规则。

"0"作为特殊的错误码，表示成功，其余表示失败。

错误码由五位数字组成：

• 第一位数字：代表错误的类型，比如"4"就是请求不合法；"5"就表示服务器处理错误。
• 第二位数字：表示在错误类型下的分组，比如“40”是一类请求错误，“41”又是另一类请求错误。
• 后三位数字：具体的错误，范围从001~999，这个范围基本上是够用的。

这种规则优缺点都是非常明显的：

• 优点：规则非常简单，且对英语水平没有要求。
• 缺点：通过错误码看不到任何有用的信息，必须查错误码表

字母+数字组合，比如华为云的一些开放接口，就是使用这种错误码。
https://support.huaweicloud.com/api-oms/ErrorCode.html

错误码只有两部分：前缀和错误编码，因为系统功能比较单一，所以也没必要按模块划分。

这里使用“.”作为分隔符，可以根据习惯选择其他分隔符。

这种错误码的规则是我比较推荐的。

• 首先，它一定程度上降低了纯数字错误码的不便。因为前缀是英文，所以能很快的定位是哪个模块出了问题。
• 其次，错误编号部分使用数字，也避免了程序员起名纠结问题。

纯字母，阿里云的一些产品就是这种错误码。

这种错误码，我在项目中用过一段时间，后来被直接劝退——很多时间都浪费在起名字上了。现在有了AI，起名字不再是问题，但是你无法保证团队其他成员也能认真的起名，总之到最后很容易乱。

不推荐。