2016 - 2024

感恩一路有你

苹果手机word文档编辑 怎么看待一些后端程序员不写接口文档,老是以很忙为借口搪塞?

浏览量:1783 时间:2021-03-30 20:43:42 作者:admin

怎么看待一些后端程序员不写接口文档,老是以很忙为借口搪塞?

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

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

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

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

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

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

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

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

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

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

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

如何正确规范写接口文档?

编写文档,无论是接口文档还是需求文档。关键是双方都需要能够在第一时间理解并达成共识,这是一个好的文件。

对接口文档有几点建议:1。前提条件应该明确定义

前提条件包括接口环境、项目版本号等,因为许多公司同时运行多个版本。在不注意前提的情况下,很容易出现一些让人欢笑的事情。测试过程中有很多问题。结果发现前端环境或者版本号是错误的,浪费了很多时间,没有意义。

2. 需要定义一般退货编码

一般退货编码包括一般成功、一般异常等,此类一般退货内容可以定义一次,以下关于业务处理的退货编码可以省略,不能写入这些内容;

3。必须给出参数传递和返回的例子

例子可以很好的避免一些不必要的问题,一个好的接口文档可能就是一些例子。节省时间和精力。

苹果手机word文档编辑 苹果手机接口 ios的word文档软件

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