包括以下六个质量指标评估:正确性评估、数据时效评估性、可靠性评估、安全性评估、性能评估、容量评估。
一、正确性评估
1、入参字段
明确每个字段的业务含义、数据类型、是否必传&默认值。如果支持批量,确认批量个数;如果支持分页,确认分页大小,终止条件。
2、返回结果
明确每个字段的业务含义、是否必有;如果没有返回结果,延迟重试是否可以获取到?
3、返回码
确认每个返回码的含义,是否存在多个在业务层面是成功的返回码,同时需要评估每个业返回码是否需要进行特殊处理。
二、数据时效性评估
一般时效性包括三类:实时、准实时、离线。 实时:查询主库; 准实时:查询从库(排除同步复制) 或者 查有缓存。如果对结果的实时性把握不准,则会直接影响业务的正确性。
三、可靠性评估
需要知道在调用对方接口失败后,是否重试可提高可靠性或者进行降级处理。比如:对方结果返回null,是因为主从延迟,或者是查询缓存失败等,此时可以进行重试。
四、安全性评估
调用对方接口之前,需要确认接口是否需要鉴权,有些服务方,测试环境没配置需要鉴权,则生产环境需要鉴权,如果没让对方没给权限,则上线即报错;以及入参是否需要加密、返回结果是否加密、脱敏了。
五、性能评估
一般看对方服务的TP四个九请求耗时是否满足要求,其次接口调用一般要设置超时时间,一般也是以TP四个九为基准,同时参考请求最大耗时,当然如果对接口的可靠性要求非常高,则需要评估在调用失败之后是否可以做降级处理。
六、流量&容量评估
评估 对方最近一段时间的峰值QPS 是否 满足要求,如果不满足,自己需要限流 或者 要求对方扩容等;否则就会出现接口超时。