【243期】面试官问：如何设计 API 返回码（错误码）？

Java精选 2022-08-09

收录于合集

#面试题系列专栏 349 个

#面试官问 405 个

点击上方“Java精选”，选择“设为星标”

别问别人为什么，多问自己凭什么！

下方有惊喜，留言必回，有问必答！

每天 08:15 更新文章，每天进步一点点...

前言

客户端请求API，通常需要通过返回码来判断API返回的结果是否符合预期，以及该如何处理返回的内容等。
相信很多同学都吃过返回码定义混乱的亏，有的API用返回码是int类型，有的是string类型，有的用0表示成功，又有的用1表示成功，还有用“true”表示成功，碰上这种事情，只能说：头疼。
API返回码的设计还是要认真对待，毕竟好的返回码设计可以降低沟通成本以及程序的维护成本。

HTTP状态码参考

以HTTP状态码为例，为了更加清晰的表述和区分状态码的含义，HTTP状态做了分段。

对于后端开发来说，我们通常见到的都是：
2XX状态码，比如200->请求成功。
5XX状态码，比如502->服务器异常，通常就是服务没正常运行，或者代码执行出错。

推荐下自己做的 Spring boot 的实战项目：
https://gitee.com/yoodb/jing-xuan‍

通过状态码即可初步判断问题原因，HTTP状态的设计思路值得借鉴。

参数约定

虽说是返回码设计，但是只有code是不行的，还要有对应的message，让人可以看懂。

参考HTTP状态码的思路，我们对错误码进行分段。

通过这样的设计，不论是程序还是人都可以非常方便的区分API的返回结果，关键是统一！

个性化Message

通常我们的Message都是写给工程师看的，但是在不同的场景下，同样的错误，可能需要给用户看到不一样的错误提示。
比方说20000-29999表示订单创建失败：

20001，订单创建失败，存在进行中的订单
20002，订单创建失败，上一个订单正在排队创建中

这两种错误情况如果是给用户看，可能就只适合看到：很抱歉，您有一个正在进行中的订单，请到我的订单列表中处理。另外，更多关于java面试题，公众号Java精选，回复java面试，获取最新面试题资料，支持在线随时随地刷题。
但是对于API来说，返回的信息又必须是准确的，但用户看到的就必须转译，这个转译的工作调用方可以做，但是通常API提供者来提供个性化的Message能力会更好。