如何设计 API 返回码（错误码）？

一、前言

客户端请求API，通常需要通过返回码来判断API返回的结果是否符合预期，以及该如何处理返回的内容等

相信很多同学都吃过返回码定义混乱的亏，有的API用返回码是int类型，有的是string类型，有的用0表示成功，又有的用1表示成功，还有用”true”表示成功，碰上这种事情，只能说：头疼

API返回码的设计还是要认真对待，毕竟好的返回码设计可以降低沟通成本以及程序的维护成本

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

对于后端开发来说，我们通常见到的都是：

2XX状态码，比如200->请求成功，

5XX状态码，比如502->服务器异常，通常就是服务没正常运行，或者代码执行出错

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

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

字段	类型	说明
code	int	返回码
message	string	返回码说明

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

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

通常我们的message都是写给工程师看的，但是在不同的场景下，同样的错误，可能需要给用户看到不一样的错误提示。

比方说 20000-29999表示订单创建失败：

这两种错误情况如果是给用户看，可能就只适合看到：很抱歉，您有一个正在进行中的订单，请到我的订单列表中处理。

但是对于API来说，返回的信息又必须是准确的，但用户看到的就必须转译，这个转译的工作调用方可以做，但是通常API提供者来提供个性化的Message能力会更好

我们可以把转译的消息配置到数据库，并缓存到Redis或者API本机

application_id	code	message
100001	20001	很抱歉，您有一个正在进行中的订单，请到我的订单列表中处理。
100001	20002	很抱歉，您有一个正在进行中的订单，请到我的订单列表中处理。