如何设计API返回码(错误码)?
以HTTP状态码为例,为了更加清晰的表述和区分状态码的含义,HTTP状态做了分段。搜索公众号互联网架构师后台回复“2T”,获取一份惊喜礼包。
对于后端开发来说,我们通常见到的都是:
5XX状态码,比如502->服务器异常,通常就是服务没正常运行,或者代码执行出错。
通过状态码即可初步判断问题原因,HTTP状态的设计思路值得借鉴。
参数约定
虽说是返回码设计,但是只有code是不行的,还要有对应的message,让人可以看懂。
通过这样的设计,不论是程序还是人都可以非常方便的区分API的返回结果,关键是统一!
返回信息的统一处理
有了统一的code,我们就可以通过Nginx或者APM工具统计API请求Code数量及分布信息。
我们可以根据单位时间内99999的数量来做API的异常告警。
我们可以根据Code的返回饼图,帮助我们发现系统、业务流程中的问题。
全栈架构社区交流群
「全栈架构社区」建立了读者架构师交流群,大家可以添加小编微信进行加群。欢迎有想法、乐于分享的朋友们一起交流学习。
看完本文有收获?请转发分享给更多人
往期资源:
评论