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

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

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

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

案例4 1. 需求背景

需求生成服务需要告诉采购系统采购需求,以让采购系统下采购订单;采购系统对数据的要求根据不同的情况而不同,这里假设:A类需求必须有字段a,B类需求不需要有字段a。2. 需求设计

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

A类需求没有字段a的时候,返回报错信息“A需求字段a不能为空”;B类需求有字段a的时候,返回报错信息“B需求字段a应该为空”。在与开发沟通的过程中,他们提出:如果B类需求给了字段a,会不会影响后面的流程?

我的回答是:不会,只是这个信息后面流程用不到。

推荐阅读