汇智动力

售前免费咨询热线: 4 0 0 - 1 8 6 - 0 9 0 5
汇智资讯Huizhi information

当前位置:首页 »后端开发完接口才给出接口文档合理吗?

后端开发完接口才给出接口文档合理吗?

日期:2021-03-17 10:15:43 访问量: 来源:

肯定是不合理的,项目的整个研发流程还有前端还有测试,还有其他的后端人员,不可能通过口口相传来进行接口说明,所以必须要写接口文档。

后端开发

从团队合作

如果项目是前后端分离架构的,那一定涉及到前端开发人员还有测试人员,还有其他后端开发人员,这些人都有需要去了解接口到的实现,如果不写接口文档,那这些人怎么办,如何了解到接口的设计,地址是什么,传参是什么,参数的长度、类型,是否是必传的,总不能天天问开发,如果是这样那就是给自己挖了一个大坑,优秀的开发是不会这样做的。即使不是前后分离,测试也没有,都由研发自己负责,那随着不断的迭代,接口越来越多,当需要去了解以前的接口设计时,就得回去看代码,自己也会疯掉,远不如看文档来的清晰明了。清晰明了的接口文档有助于团队之间的合作,其实也会为自己省去不少时间。

传承

互联网公司的流动性大,这是众所周知的,随着人员的流动,本来做这个接口的人员离职了,新接手的同学要想了解以前的接口,只能看代码,还是痛苦。再有新来的前端同学和测试同学想要了解接口,怎么办。

个人

程序员最讨厌的四件事情,不喜欢看别人的代码,不喜欢别人的代码没有注释,不喜欢自己写注释,不喜欢自己写文档。看似简单的接口文档,其实体现的是研发人员的接口设计能力,当输出到的接口文档不会被人挑刺,不会被问死,那说明设计能力已经不错了。而且写出优秀的文档本身也是对自己写作能力的一种锻炼,何乐不为呢。

质量

接口文档体现的是研发对这个接口实现的设计,当对业务需求、前后端交互有足够的理解,才能写出优秀的文档,这本身也是质量管理的非常重要的一个步骤。

总结

需求研发的过程每个组都会输出自己的文档,产品要输出合理详细的需求文档,研发输出优秀的设计文档和接口文档,测试输出完善的测试方案和覆盖全面的测试用例,各个环节都尽自己的努力输出该有的东西,相信产品的上线质量会好很多。

相关阅读Reading

全国热线:400-186-0905

总部热线:028-6547-1147

周一至周日9:30-24:00

我要咨询
汇智动力微信

汇智动力微信公众号