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

科技频道提示您本文原始标题是:4个真实案例,看接口文档的设计要点

接上一篇文章《4个要点,编写一份接口需求文档》,本文对工作中做过的实例进行分析,希望通过实例能对接口设计需要考虑的因素有更深的理解。

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

案例1 1. 需求背景

SRM系统的用户,需要在SRM查看自己提供的商品的质检情况;但是质检的数据在商品管理系统中,故需要SRM从商品管理系统获取对应的数据2. 需求设计

需求关键点是SRM需要从商品管理系统获取数据并展示给自己用户,实现这一点有两种方式:

(1)SRM固定频次从商品管理系统获取

选择这种方式,有一个绕不开的问题:什么时候去取数据合适?普遍的自然就想到按固定的频率,那么这个频率应该是什么?

考虑到用户随时都会点击查看,半小时、一小时的频率肯定不行;实时性应该越高越好,那半分钟或者1分钟取一次呢?

推荐阅读