先写接口文档还是先开发


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

先写接口文档是正确的

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

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

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

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

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

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

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

什么情况可以先开发

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

  • 6
    点赞
  • 10
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
接口开发是指根据接口文档来编程序,实现不同系统之间的数据交互和功能调用。在进行接口开发时,需要了解清楚接口文档中规定的参数、请求方式、返回数据格式等信息。 首,我们需要根据接口文档中的要求,选择合适的开发工具和编程语言。一般来说,接口开发常用的编程语言有Java、Python、C++等,可以根据项目需求和团队技术栈来选择合适的语言。 接着,根据接口文档中定义的接口地址、请求参数和返回数据格式,我们可以开始编接口开发的代码。根据接口文档中的请求方式(如GET、POST、PUT、DELETE等),我们可以使用相应的HTTP请求库来发送请求,并根据接口文档中的返回数据格式(如JSON、XML等),我们可以解析相应的返回数据。 在编代码的过程中,我们需要注意参数的校验和错误处理,确保接口的健壮性和安全性。此外,我们还需要考虑接口的性能优化和接口文档的变更管理,确保接口的稳定性和可维护性。 最后,我们可以通过接口测试工具(如Postman、Swagger等)来测试接口的功能和性能,确保接口开发的质量和正确性。 总的来说,根据接口文档接口开发c需要我们严格按照接口文档的要求进行开发,确保接口的功能和性能符合预期,同时要注重接口的健壮性和稳定性,以实现不同系统之间的数据交互和功能调用。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值