4个真实案例,看接口文档的设计要点( 六 )
此次的设计解决了前两次的问题,但是没有考虑异常情况:没有满足条件的数据时,要返回什么来告诉对方为什么没有数据?所以接口还需要一个错误信息。
(4)结合以上,最后的设计如下:
案例4 1. 需求背景
需求生成服务需要告诉采购系统采购需求,以让采购系统下采购订单;采购系统对数据的要求根据不同的情况而不同,这里假设:A类需求必须有字段a,B类需求不需要有字段a。2. 需求设计
一开始设计的文档的时候,我是这样设计校验的:
A类需求没有字段a的时候,返回报错信息“A需求字段a不能为空”;B类需求有字段a的时候,返回报错信息“B需求字段a应该为空”。在与开发沟通的过程中,他们提出:如果B类需求给了字段a,会不会影响后面的流程?
我的回答是:不会,只是这个信息后面流程用不到。
推荐阅读
- 原神|原神:为啥这4个角色,前期被玩家称为真神,后期却开始无人问津
- 地下城与勇士|DNF:像素勇士2.0奖励!白送4个黄绿徽章,能拿限定光环武器装扮
- 传奇|璀璨传奇复古:当年盛大为了公平法战的pk 默认了一个谣言的真实性
- 游戏日报|玩了4个小时的《幻塔》后,我给它打了9分
- 商人|游戏商人的月入百万是真的吗?揭秘真实的剑三游戏商人真实现状
- 阴阳师|阴阳师:一句话证明你玩过阴阳师,过于真实!
- 第五人格|第五人格:一不小心就成了黑历史,这些糗事是萌新玩家的真实写照
- 热血传奇|热血传奇:刀刀都是真实伤害,这件武器就是神器!
- 黑龙|魔兽怀旧服:滚动服首次击败黑龙MM,4个硬核改动,劝退休闲玩家
- 手机游戏|英雄联盟手游能和端游进行绑定么?LOL手游人气不高,原因很真实