目录

• 前言

• 设计好接口的 36 个锦囊

• 总结

前言

作为后端开发，不管是什么语言，Java、Go 还是 C++，其背后的后端思想都是类似的。我们做后端开发工程师，主要工作就是：如何把一个接口设计好。所以，今天就给大家介绍，设计好接口的 36 个锦囊。

设计好接口的 36 个锦囊

| 接口参数校验

入参出参校验是每个程序员必备的基本素养。你设计的接口，必须先校验参数。

比如入参是否允许为空，入参长度是否符合你的预期长度。这个要养成习惯哈，日常开发中，很多低级 bug 都是不校验参数导致的。

比如你的数据库表字段设置为 varchar(16)，对方传了一个 32 位的字符串过来，如果你不校验参数，插入数据库直接异常了。

出参也是，比如你定义的接口报文，参数是不为空的，但是你的接口返回参数，没有做校验，因为程序某些原因，直返回别人一个 null 值...

| 修改老接口时，注意接口的兼容性

很多 bug 都是因为修改了对外旧接口，但是却不做兼容导致的。关键这个问题多数是比较严重的，可能直接导致系统发版失败的。新手程序员很容易犯这个错误哦~

所以，如果你的需求是在原来接口上修改，尤其这个接口是对外提供服务的话，一定要考虑接口兼容。

举个例子吧，比如 dubbo 接口，原本是只接收 A，B 参数，现在你加了一个参数 C，就可以考虑这样处理：