【接口设计】这样写接口更优雅

总目标：安全性，可重复调用，稳定性，追溯性

1.签名：对外提供的接口要做签名认证，认证不通过的请求不允许访问接口、提供服务。

2.加密：敏感数据在网络传输过程中应该加密。

3.IP白名单：限制请求的IP，增加IP白名单，一般在网关层处理。

4.限流：尤其是对外提供的接口，无法保障调用的频率，应该做限流处理，保障接口服务正常提供服务。

5.参数校验：即使前端做了非空，规范性校验，服务端参数仍然是非常必要的。

6.统一返回值：一个服务一套统一的数据返回结果和传参规范。

7.统一异常封装：系统报错友好提示，避免暴露出sql异常的信息给调用方。

8.请求日志：记录系统产生的日志，方便快速定位分析问题。

9.幂等设计：对于一些涉及到数据一致性的接口一定要做好幂等设计，防止数据出现重复问题。

10.限制记录条数：对于对外提供的批量接口，一定限制请求的记录条数。

11.压测：上线前我们必须对API接口做一下压力测试，知道各个接口的qps情况。以便我们能够更好的预估，需要部署多少服务器节点，对于API接口的稳定性至关重要。

12.异步处理：如果同步处理业务，耗时会非常长。这种情况下，为了提升API接口的性能，我们可以改成异步处理。

13.数据脱敏：关系到业务中用户的敏感数据要进行脱敏处理。

14.完整的接口文档