2016 - 2024

感恩一路有你

接口设计文档模板 后端开发完接口才给出接口文档,合理吗?你怎么看?

浏览量:2996 时间:2021-04-03 09:59:10 作者:admin

后端开发完接口才给出接口文档,合理吗?你怎么看?

一个非常好的问题,我是工作多年的Web应用架构师,来回答一下这个问题。欢迎关注我,了解更多IT专业知识。


后端给出接口文档太晚,也合理也不合理,要看具体情况,总有解决方法,我来说一下我的观点。


不合理:成熟的技术团队,重视功能设计,在动手写代码之前已经有了完整的技术文档和功能定义,甚至在TDD测试驱动开发模式中,测试数据已经准备就绪,那么这时接口文档不管写没写,接口逻辑都是已经确定的,整理出来是水到渠成。


合理:多存在于早期小型创业公司,主观客观原因都有。


- 先说主观原因。赶进度、没时间、懒得写,甚至开发前都没做仔细的设计,边做边改,这些原因普遍存在,也实在没啥好办法。


- 客观原因,需求在变,功能跟着变,接口也要变,那么如果写了文档,理所当然也要更新维护啊?我的天哪。


有解决方法吗?建议试试:

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


2,Postman接口测试工具,导入导出JSON文件,高效团队协作。Postman支持各种请求方式和配置环境变量,并对返回结果进行测试校验,支持批量自动化运行,可以和自动构建系统集成。

接口设计文档模板 php api接口开发实例 api说明文档怎么写

版权声明:本文内容由互联网用户自发贡献,本站不承担相关法律责任.如有侵权/违法内容,本站将立刻删除。