幸运分分彩 首页 > 学霸

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

2019-09-10 22:17 weila

(2)既然客服系统没有状态值,那它只根据商品编码来获取,我将供应商及其状态都返回给它不就可以了,为此我的第二版设计是这样的:

这样的设计其实跟第一版有同样的问题,即使将状态返回给它,它因为不知道这些状态的业务意义,也就无法过滤掉那些没用的数据只给客服人员展示有效的信息。

(3)经过两版分析,我的第三版设计如下:

此次的设计解决了前两次的问题,但是没有考虑异常情况:没有满足条件的数据时,要返回什么来告诉对方为什么没有数据?所以接口还需要一个错误信息。

(4)结合以上,最后的设计如下:

案例4 1. 需求背景

一开始设计的文档的时候,我是这样设计校验的:

在与开发沟通的过程中,他们提出:大发一分彩B类需求给了字段a,会大发一分彩影响后面的流程?

我的回答是:大发一分彩,只是这个信息后面流程用不到。

那么当B类需求给了字段a的时候,还是正常接收数据,只是不接收字段a。

这样做的好处是:接口校验少了一层,变得更轻更简单;大发一分彩因为一个用不到的信息影响后面的流程。

所以改一下校验逻辑:

这里涉及到接口设计中的校验,增加校验的目的是,保证相互通讯的数据是正确的,对接收方而言保证五分PK10受到的信息不是垃圾数据或因为错误而影响后面流程。

但是在设计校验规则时,应该有一个强校验还是弱校验更合适的考量。正如上文的接口,A类需求的字段a是后面流程必须用到的信息,所以必须采用强校验;相反B类采用弱校验即可。

PS:诚然,除了这些问题以外,还有主明细方式传输、分页、最大量限制等等的点,最好的方式是在搞清楚业务需求后,及时跟开发同学做下探讨和沟通,听听他们的意见和考量(所以处好关系很重要呀,哈哈)。

#专栏作家#

果果,人人都是产品经理专栏作家。擅长业务导向性的产品设计,以及对业务流程的梳理和复杂问题的拆解,希望能找到产品工作的操作指南和方法论,不断搭建五分PK10的知识体系

题图来自Unsplash, 基于CC0协议,