2016 - 2024

感恩一路有你

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

浏览量:2675 时间:2021-03-12 06:08:53 作者:admin

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

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

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

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

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

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

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

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

接口编程中,为什么只用get和post?

得到,帖子就够了。。restful接口呢?完成这项工作很好。别修那些花哨的

1。为什么是web API?

Web API是一种网络应用程序接口。它包含广泛的功能。通过API接口,网络应用可以实现存储服务、消息服务、计算服务等功能,利用这些功能可以开发出功能强大的web应用。

2、Web平台分为七个基础设施,线索是这些产品提供了API,分别是:1)存储服务:存储服务侧重于抽象化和虚拟化存储。

2)Openemy服务:它提供了一个类似于文件系统接口的API,但增加了标记文件的功能。

3)消息服务:消息服务在概念上类似于传统的中间件。

4)计算服务:目前,没有可以通过API访问的web计算服务的通用黑盒,但是有许多技术指向这个方向。

5)信息服务:信息服务提供大量具体信息。6)搜索服务:由于搜索在Web领域的基础和优势地位,搜索服务构成了新的Web基础结构的关键部分。

7)Web2.0服务:最后一大类称为Web2.0服务。

webAPI怎样理解?

不写接口文档,一般很忙。或者没有时间整理文件。

对于前端和后端的对接,前端开发人员一般需要后端人员提供接口文档,而现在招摇过市的文档完全可以提供这个功能。在许多情况下,后端开发人员集成了一个swagger并自动生成相应的文档。

您可以给后端开发人员一定的时间来学习swagger或将swagger集成到项目中。

api接口文档 在线api文档 api文档编写工具

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