总目标:安全性,扩展性,稳定性,追溯性,幂等性等等
- 签名:对外提供的接口要做验证签名,认证不通过就不允许访问接口或服务等等。
- 加密:接口数据在网络空间传输需要进行加密。
- IP黑白名单:鉴别请求接口的IP地址,在网关层进行处理,只允许白名单通过或是限制黑名单访问等等。
- 限流:尤其考虑到对外服务的接口,无法预估到调用频率(或是按照业务统计出高峰等等),应该要对服务进限流,保证服务的正常运行。
- 参数校验:后端要对接口进行规范,一定要做好参数的校验,不能信赖依靠前端的校验来解决。
- 统一返回值:一个服务或是一套系统,都应该规范好数据的传参和返回值。
- 统一异常封装:系统报错时,应该给友好的提示,避免把报错信息暴露给用户端。
- 幂等设计:对于接口涉及到数据一致性问题,一定要考虑好是否要对接口进行幂等处理,防止数据重放。
- 请求日志:要添加上日志信息,可以快速定位排查问题。
- 限制批量条数:对于批量操作的接口,一定要对其进行条数限制,避免出现网络超时,内存溢出泄露等等问题。
- 异步处理:如果同步调用接口消耗时非常大,对于这种情况,可以考虑把非必要业务进行剥离放在异步进行处理。
- 数据脱敏:在业务里需要对敏感数据(身份证,手机号等等)进行处理脱敏处理存库或是打印日志,保证数据的安全性。
- 压测:如接口的QPS预测非常高,需要对接口进行压测,评估服务器性能是否能达到要求,并出异常时处理方案等等。
- 要完整的接口文档