Api接口文档问题

Api接口文档问题

实际工作中,前后端分离的项目,一般接口文档由谁写?是由后端开发工程师编写?还是项目技术负责人编写?
另外接口文档是在后端开发前就编写好,还是后端开发完成后才编写?

正在回答

登陆购买课程后可参与讨论,去登陆

2回答

同学你好,1、接口文档设计和编写的时间并不是必须要几天,而是根据项目的复杂程度以及业务的逻辑来完成,有的项目比较复杂,花费的时间就比较多,有的项目比较简单,业务逻辑也不复杂,花费的时间就比较少,所以这个时间并不固定。

    ​所以即使是确定有100个接口,也不会确定具体的时间,就能写出来。

    ​2、作为后端开发人员,并不是必须要有接口文档设计和编写能力,但是要能看懂接口文档,一般情况下,接口文档是由前后端一起开会讨论出来的。而且在一些比较大的公司中,接口文档是由架构师或者其他经验比较丰富的人来,并不会让新人来写。

    如果刚进公司接触的是维护型的项目,那也是不用写接口文档的,不过良好的接口文档设计和编写也是一个很强的能力,如果同学感兴趣也可以去学习一下。

好帮手慕小班 2020-12-01 11:00:21

同学你好,1、接口文档是在项目初始阶段,根据产品需求,由前后端共同完成,并不是由一个人来写的。

    ​2、在项目设计阶段,根据需求完成接口文档,在开发阶段,根据接口文档来完成项目的开发,所以接口文档是在后端开发前就编写好的。

  • 提问者 慕丝1539783 #1
    接口文档设计和编写花费的时间会多么?比如有100个接口,大概需要花几天时间? 作为后端开发人员,接口文档设计和编写是一定要会的技能么?
    2020-12-01 12:48:24
问题已解决,确定采纳
还有疑问,暂不采纳

恭喜解决一个难题,获得1积分~

来为老师/同学的回答评分吧

0 星

相似问题

登录后可查看更多问答,登录/注册

请稍等 ...
意见反馈 帮助中心 APP下载
官方微信

在线咨询

领取优惠

免费试听

领取大纲

扫描二维码,添加
你的专属老师