关于接口文档和开发流程

因为经常涉及写api,所以对于写接口文档自然不陌生。对于写接口文档真想吐槽几句开发流程,聊以自慰。

代码一点没写,就要详细的接口文档,这事估计很多后端同学都遇到过,弄起来真是很郁闷。文档可以写,没问题,但是我不能保证一点不改。因为在开发前谁也无法预料到开发过程中会有哪些情况发生,一开始写的文档,自然与后来真正开发的接口存在些差距,这也是我不太愿意一开始就给出详细文档的原因,接口在开发过程中不断完善,一点点成型,文档自然一点点成型,这时候给出的文档自然是一致的,不需要二次修改的。

测试同学或者前端同学可能要说了,没有详细文档,怎么进行开发。其实从开发流程上说,后端作为数据获取和组织层,理应是优先进入开发阶段的,思路出来了,代码写出一部分了,接口文档自然出来了,然后前端同学可以进入共同开发测试了,测试同学也可以开始搞测试用例了。

后端同学在开发流程的时间安排上是“前有堵截,后有追兵”。怎么讲呢?咱们来梳理下整个的开发流程,产品需求和ui就不讲了,从产品成型出来后,产品同学各种pk宣讲下来,自然有产品文档,所以只要产品文档移交开始,后端同学的任务就开始了,前面是产品同学的deadline,后面紧跟着就是前段同学和测试同学开始要文档的声音了。

什么时间才是后端同学合适的进入阶段?从个人角度讲,合适的话,产品立项后,后端同学就应该介入了,进行底层开发、梳理接口,等产品文档完善、宣讲结束,产品文档随之慢慢成形,前端即可进入开发,测试开始写测试用例等等。后面的事情就是配合前端以及配合测试等等。

随便吐槽几句开发流程,大家莫要当真。

原文地址:https://www.cnblogs.com/gaoj87/p/3414699.html