首页 > 常见问答

api接口文档系统 后端开发完接口才给出接口文档，合理吗？你怎么看？

实习编辑 • 2023-12-04 15:50:11 • 常见问答 • 阅读 3

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

一个非常好的问题。我是一个web应用程序架构师，多年来一直致力于回答这个问题。欢迎跟我来了解更多。

后端提供接口文档为时已晚，这是合理和不合理的。根据具体情况，总有解决办法。让我谈谈我的观点。

不合理：成熟的技术团队重视功能设计，在编写代码之前有完整的技术文档和功能定义。即使在tdd测试驱动的开发模式下，测试数据已经准备好了，那么接口逻辑就已经确定了接口文档是否编写好了，理清它们是很自然的。

-第一，主观原因。原因是多方面的，比如赶进度，没有时间，不懒得写，甚至在开发前没有仔细设计，在做的时候也有变化。真的没有好办法。

api接口文档系统 后端开发完接口才给出接口文档，合理吗？你怎么看？

-客观原因：需求在变化，功能在变化，接口也在变化。所以，如果你写了一个文件，它的自然更新和维护？天哪？

有解决方案吗？建议尝试：[1]swagger接口文档，将文档集成到代码中，集成维护文档和修改代码，在修改代码逻辑的同时方便修改文档描述。

2、邮递员界面测试工具，导入导出json文件，高效的团队合作。postman支持各种请求方法和配置环境变量，对返回的结果进行测试和验证，支持批量自动操作，可与自动构建系统集成。

api接口文档系统json接口文档模板api接口文档

原文标题：api接口文档系统 后端开发完接口才给出接口文档，合理吗？你怎么看？，如若转载，请注明出处：https://www.tzjingsheng.com/wenda/49042.html
免责声明：此资讯系转载自合作媒体或互联网其它网站，「豪运号」登载此文出于传递更多信息之目的，并不意味着赞同其观点或证实其描述，文章内容仅供参考。

api接口文档系统 后端开发完接口才给出接口文档 合理吗？你怎么看？ api接口文档系统 后端开发完接口才给出接口文档 合理吗？你怎么看？介绍
赞 ( )
打赏 微信扫一扫微信扫一扫
上一篇：舟山特色美食攻略 舟山有什么值得推荐的美食？ 下一篇：c语言编程软件手机版 学编程需要什么基础？

相关推荐