消息关闭
    暂无新消息!

这是微信公众平台接口的返回码。做项目的时候,需要API接口返回码,想知道API接口返回码怎么去设计啊?


我的意思是怎么去设计 不同的返回码 代表不同的 含义 , 例如 40001 表示 XXX意思 , 40002 表示 XXX意思,这些应该这么去设计呢?谢谢大家了


4个回答

︿ 1

应用开发里用错误名比错误码更好,代码更好读。

想象一下你的客户端代码:

if (error === 'ERROR_INVALID_ACCESS_TOKEN') { ... }

vs

if (error === 40010) { ... }

国内的API提供方有时是为了照顾国内开发者对英文不熟悉(或者API开发者本身不想起英文名字),所以用了数字错误码。

数字码在系统级别意义比较大,因为传输效率高(如二进制协议),对于大量的JSON格式的字符串传输协议,这点效率是不重要的。

可读性重要得多,而且错误名比错误码有无结构的优点,有扩展优势。

︿ 0

你可以学微软的,比如 ERROR_SUCCESS 是 0 代表成功。从 1 开始就定义错误代码,直到一万多。那么你可以把错误代码分为一些区间,比如 1~1000、1001~2000、2001~3000 等,分别代表什么类型的意义,然后每个区间可以从基础的能想到的错误代码开始进行定义,之后也可以少量扩增。

︿ 0

给你提供我的想法,
特殊的返回码:(各个接口通用)
0,代表成功
-1,代表服务器内部错误
普通的错误返回码:
第一个数字代表返回不同接口,
其余的就是错误类型了,按照重要性递减排列。

其实没必要这么深研究,我觉得这样就够了。
和微信的差不多。
重要的是一定要简约。