4个真实案例,看接口文档的设计要点( 四 )

4个真实案例,看接口文档的设计要点

从表面上看,这个接口设计没有问题,完全满足需要。

但是忽略的一个问题是:因为双方没有明确约定数据更新方式,导致两边数据对不上出了bug。

很明显,同步方是以全量的方式同步数据的,但是接收方在接收数据的时候,却是以增量的方式更新的。

当一个产品前一天同步的未订数量是34,第二天这个数量更新成了0的时候,接收方没有将34更新成0,存的还是34。

案例3 1. 需求背景

客服系统需要根据客户的要求,向商品的供应商索取商品操作指南等辅助信息;因为客服系统没有供应商信息,故需要从SRM系统获取供应商信息;已停止合作的供应商应排除掉;供应商需要产品对应。2. 需求设计

(1)考虑到客服系统对状态有要求,为了更加灵活,我将接口设计如下:

推荐阅读