先写接口文档还是先开发


之前都是个人维护一个项目,一直都是先开发,然后再写文档,也能保证功能的正确实现。
突然有一个大功能,需要多方协调。还是先开发,被鄙视了。

先写接口文档是正确的

一般来说,先写接口文档是正确的。尤其是时间紧,需要前后端同时开发的时候。
如果各开发各的,到后来很大概率对不上。这就尴尬了。

所以先由经验丰富的同事,定义好接口的名称,描述,出参,入参。 前后端都按照这个来开发,协作起来比较方便。

接口文档列表,也是对功能的一个概览。大致有多少个功能点,都可以清清楚楚。

为什么有的人喜欢先写开发

这种一般来说都得是实干型的,理解需求后,二话不说就是干。

如果不用协同开发,那么自由度会高一些,只要功能实现了,工期也不误就行。一般适合独自作战。

即使自己开发,先写接口文档也是可以的。因为写接口文档的时候可以梳理清楚逻辑,对开发也有指导作用。

什么情况可以先开发

1、需求频繁变动,接口文档需要反复调整。 不得不说,写接口文档还是要费不少时间的。
2、主功依赖的基础服务太多。 那么基础服务的搭建是必须的,无论如何绕不开,而且和接口功能没有直接联系。那么可以先开发这一块。减少以后的工作量。


版权声明:本文为enthan809882原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。