后端API接口定义返回编码规则

code状态码

code返回状态码,一般小伙伴们是在开发的时候需要什么,就添加什么。

如接口要返回用户权限异常,我们加一个状态码为101吧,下一次又要加一个数据参数异常,就加一个102的状态码。这样虽然能够照常满足业务,但状态码太凌乱了。

我们应该可以参考HTTP请求返回的状态码(下面是常见的HTTP状态码):

200 - 请求成功
301 - 资源(网页等)被永久转移到其它URL
404 - 请求的资源(网页等)不存在
500 - 内部服务器错误

image
我们可以参考这样的设计,这样的好处就把错误类型归类到某个区间内,如果区间不够,可以设计成4位数。

#1000~1999 区间表示参数错误
#2000~2999 区间表示用户错误
#3000~3999 区间表示接口异常

再在枚举中定义,状态码
image
我们要设计一个返回体类Result
image

posted @ 2024-07-22 16:47  spiderMan1-1  阅读(125)  评论(0编辑  收藏  举报