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

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

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

所以改一下校验逻辑:

A类需求没有字段a的时候,返回报错信息“A需求字段a不能为空”;B类需求有字段a的时候,不接收字段a,但正常接收需要的其他字段。这里涉及到接口设计中的校验,增加校验的目的是,保证相互通讯的数据是正确的,对接收方而言保证自己受到的信息不是垃圾数据或因为错误而影响后面流程。

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

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

推荐阅读