接口错误码:数字ID优于字符串描述?
在设计接口返回的错误码时,是选择数字ID还是字符串描述,一直是开发者关注的焦点。
虽然字符串描述更直观易懂,但我们建议采用数字ID作为错误码,并单独使用errmsg
字段返回错误信息。
这种方法的优势在于:
errmsg
提供的详细描述,可以满足不同场景下的错误信息需求。例如,微信接口的错误码结构就是一个很好的范例:
{
"errcode": 40010,
"errmsg": "错误信息"
}
errcode
是简洁的数字ID,errmsg
则提供了详细的错误解释。 这种设计兼顾了错误码的简洁性和信息丰富性,方便开发者快速理解和处理错误。