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

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

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

HTTP状态码参考
图片

以HTTP状态码为例，为了更加清晰的表述和区分状态码的含义，HTTP状态做了分段。
对于后端开发来说，我们通常见到的都是：

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

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

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

参数约定
图片

虽说是返回码设计，但是只有code是不行的，还要有对应的message，让人可以看懂。
参考HTTP状态码的思路，我们对错误码进行分段。

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

个性化Message

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

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

20001，订单创建失败，存在进行中的订单

20002，订单创建失败，上一个订单正在排队创建中

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

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

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

然后在请求处理结束即将返回的时候，根据application_id+code，去匹配替换message。

这样我们就可以让手机APP的用户、微信小程序的用户、网页下单的企业用户看到不同的消息。

返回信息的统一处理
图片

有了统一的code，我们就可以通过Nginx或者APM工具统计API请求Code数量及分布信息。

我们可以根据单位时间内99999的数量来做API的异常告警。

我们可以根据Code的返回饼图，帮助我们发现系统、业务流程中的问题。

等等……

总之，好的返回码设计，可以帮助我们提高沟通效率，降低代码的维护成本。

【游戏资讯】

近日，万代南梦宫官方宣布《机动战士高达 激战任务2 》原定于4月22日开始的第二回网络测试延期，官方给出的理由为“服务器在短时间内过度集中的联机下，产生了不稳定的异常状态”，测试重启时间待定。

《机动战士高达：激战任务2》中，以MS击破敌机，用步兵展开奇袭……亲眼看清战况，发出胜利的咆哮吧！与战友并肩作战的6对6线上多人游戏《机动战士高达：激战任务2》(基本免费)，完成众多的战斗与任务，目标是成为王牌驾驶员！
#游戏资讯# #steam游戏# #Steam#

【机动战士高达 激战任务2 Steam版 第2回网络测试延期】

感谢大家一直以来对《机动战士高达 激战任务2》的支持。
由于服务器在短时间内过度集中的联机下，产生了不稳定的异常状态，
关于此异常，目前相关单位仍正在调查中，还尚需一些时间厘清与修正。
为确保各位玩家的游玩体验，最终决议将延迟第2回的网络测试。

＜第2回网络测试＞
变更前：2022年4月22日(周五) 10:00 ～ 4月24日(周日) 17:00(JST) [预定]
变更后：未定

※测试重启的日程一旦确定后，将会立即在 Steam 商品页面上发布https://t.cn/A661JvdM

造成期待此次测试玩家们的不便与困扰，我们深表歉意，
也再次感谢您的理解与配合。

#机动战士高达# #激战任务2# #GUNDAM# #BATTLEOPERATION2# #STEAM#