为什么后端开发不给接口文档?是真的给不出来

在软件开发团队里,永久的话题是程序员和产品经理之争,其实还有“内斗”,前后端程序员之间围绕API接口展开的是非恩怨。

一,探究根源

现在互联网软件大多采用动静分离架构,REST接口是前后端主要协作沟通桥梁。时间紧任务重,前端工程师不能等到后端开发结束才开始,所以希望早点拿到接口文档,并行开发,联调发布,期望高吗?

认为后端应该先给出接口文档的理由是成立的。成熟的技术团队,重视功能分析设计,在动手写代码之前已经有了完整的技术文档和功能定义。采用TDD测试驱动开发模式的团队,在功能代码完成之前测试数据已经准备就绪,那么这时接口文档不管有没有写,功能逻辑都是已经确定的,整理出来文档是水到渠成,基本上不增加额外工作量。

对于早期的小型创业团队,有点勉为其难。其实是真的给不出有用的文档,也不建议给,主观客观原因都有。

二,原因分析

1,先说主观原因

早期创业阶段,来了任务马上做,赶进度、催交付,压缩工期的现象非常普遍。996节奏下的后端开发工程师,不愿意再投入额外的时间去写文档,甚至开发前都没做仔细的技术设计,边想边做边改,这些原因普遍存在,也真的没有好办法。

2,客观原因

市场需求多变,技术迭代加快。如何应对这些变化?那只能是修改需求,功能跟着变,接口也要变,如果写了文档,总不能给出不一致甚至错误的文档吧?理所当然也要更新维护。Oh, my god!

三,解决方法

怎么办呢?建议试试:

1,小型的创业技术团队,前后端直接拿代码说事,当面口头沟通更高效。

2,后端工程师动手开发前,要设计好功能架构,虽然给不出细节文档,但是有了沟通协作基础。

3,多用成熟的脚手架,专注业务逻辑代码的开发。

4,集成Swagger接口文档框架,将文档融合到代码中,让维护文档和修改代码整合为一体,使得修改代码逻辑的同时,方便的修改文档说明。

5,使用Postman接口调试工具,对返回结果进行测试校验,支持批量自动化运行,导入导出JSON文件,高效团队协作。

6,后期集成联调查找问题时,围绕Postman脚本展开。如果Postman能调用成功,那就前端排查调用代码;反之,后端修复问题直到Postman调用成功,导出JSON脚本文件。

为什么后端开发不给接口文档?是真的给不出来

四,Spring Boot集成Swagger,自动生成接口文档

Swagger框架定义了完整的REST接口文档规范,提供了强大的页面测试功能,能够调试和可视化API接口服务。Spring Boot集成Swagger只需3步配置,就能自动生成接口文档。

为什么后端开发不给接口文档?是真的给不出来

五,Postman接口调试工具使用技巧

1,调用API并验证返回结果

Postman支持各种HTTP调用请求方式,解析和验证返回数据。当返回JSON数据时,可以配置JSON Schema调用JSON Validator。

2,配置和引用环境变量

在请求地址和参数中可以引用环境变量,还可以在解析返回结果时动态设置环境变量值。批量运行Collection时,可以使用CSV数据文件定义变量值。

为什么后端开发不给接口文档?是真的给不出来

3,Collection导出导入和批量运行

Newman命令行工具支持自动运行Collection脚本文件,可以和Jenkins等自动构建系统集成。

为什么后端开发不给接口文档?是真的给不出来


分享到:


相關文章: