接口文档更新方法、装置、电子设备及可读存储介质与流程

1.本技术涉及计算机技术领域，具体而言，本技术涉及一种接口文档更新方法、装置、电子设备及可读存储介质。


背景技术：

2.随着计算机技术逐步发展，计算机能给人们提供的算力和资源管理能力也逐渐提升，人们可以基于计算机技术创建和管理更加复杂和多样的项目，而在一个内容丰富的项目上线之前，项目的研发过程中必然结合了众多部门的心血，部门之间、研发人员之间的沟通配合尤为重要。其中，api(application programming interface，应用程序接口)文档是一个有效的“沟通媒介”，可以对项目中不同模块的接口如何进行调用、以及其中涉及到的参数的清晰的解释说明。
3.例如，对于一个包含众多功能的软件系统来说，不同功能模块可以由不同部门的研发人员承担开发任务。在模块化开发完成后，任一部门的研发人员可以通过给其他部门的研发人员提供api文档来告知其他研发人员如何使用该部门研发的功能模块，同理，该部门的研发人员也可以通过阅读其他部门提供的api文档知晓如何进行协作开发。
4.目前，大多数api文档都是由人工进行手动维护、更新以及部署，维护成本较高，api文档更新效率较低。


技术实现要素：

5.本技术实施例的目的旨在能解决接口文档更新效率较低的问题。
6.第一方面，提供了一种接口文档更新方法，该方法包括：
7.对代码远程仓库进行监听，当代码远程仓库接收到更新文件时，从代码远程仓库获取更新文件；更新文件包括针对至少一个接口的接口配置参数的更新内容；
8.基于更新文件生成更新文件对应的标记语言文件；
9.将标记语言文件发送至文档远程仓库，以使文档远程仓库基于标记语言文件更新标记语言文件对应的接口文档。
10.在第一方面的可选实施例中，当代码远程仓库接收到更新文件时，从代码远程仓库获取更新文件，包括：
11.接收代码远程仓库通过预设的事件处理接口发送的更新触发信息，更新触发信息为代码远程仓库在接收到更新文件时发送的；
12.响应于接收到的更新触发信息，向代码远程仓库发送更新文件获取请求，以从代码远程仓库获取更新文件。
13.在第一方面的可选实施例中，基于更新文件生成更新文件对应的标记语言文件，包括：
14.对更新文件进行解析得到解析结果，基于解析结果生成更新文件对应的json文件；
15.调用预设的代码处理平台对json文件进行解析，基于解析后的json文件生成更新文件对应的标记语言文件。
16.在第一方面的可选实施例中，基于解析后的json文件生成更新文件对应的标记语言文件，包括：
17.确定解析后的json文件对应的目标模板；
18.基于解析后的json文件和目标模板生成更新文件对应的标记语言文件。
19.在第一方面的可选实施例中，解析后的json文件包括更新文件对应的模板标识以及更新内容，确定解析后的json文件对应的目标模板，包括：
20.对预设的语义模板库进行检测；
21.若语义模板库中存在模板标识对应的模板，则将模板标识对应的模板作为更新文件对应的目标模板；
22.若语义模板库中不存在模板标识对应的模板，向更新文件对应的目标客户端发送提示信息；接收目标客户端返回的模板配置信息，基于模板配置信息生成更新文件对应的目标模板；目标客户端为向代码远程仓库提交更新文件的客户端，提示信息用于提示语义模板库中不存在与更新文件对应的模板。
23.在第一方面的可选实施例中，方法还包括：
24.对文档远程仓库进行监听，若文档远程仓库基于标记语言文件更新接口文档，则从文档远程仓库获取更新后的接口文档；
25.基于更新后的接口文档对至少一个接口进行配置；
26.响应于接收到的接口文档查看请求，将更新后的接口文档发送至接口文档查看请求对应的客户端，以使客户端可以基于更新后的接口文档渲染并更新客户端的文档显示界面；文档显示界面用于显示至少一个接口的接口配置参数。
27.第二方面，提供了一种接口文档更新装置，该装置包括：
28.第一监听模块，用于对代码远程仓库进行监听，当代码远程仓库接收到更新文件时，从代码远程仓库获取更新文件；更新文件包括针对至少一个接口的接口配置参数的更新内容；
29.文件生成模块，用于基于更新文件生成更新文件对应的标记语言文件；
30.文档更新模块，用于将标记语言文件发送至文档远程仓库，以使文档远程仓库基于标记语言文件更新标记语言文件对应的接口文档。
31.在第二方面的可选实施例中，第一监听模块在当代码远程仓库接收到更新文件时，从代码远程仓库获取更新文件时，具体用于：
32.接收代码远程仓库通过预设的事件处理接口发送的更新触发信息，更新触发信息为代码远程仓库在接收到更新文件时发送的；
33.响应于接收到的更新触发信息，向代码远程仓库发送更新文件获取请求，以从代码远程仓库获取更新文件。
34.在第二方面的可选实施例中，文件生成模块在基于更新文件生成更新文件对应的标记语言文件时，具体用于：
35.对更新文件进行解析得到解析结果，基于解析结果生成更新文件对应的json文件；
36.调用预设的代码处理平台对json文件进行解析，基于解析后的json文件生成更新文件对应的标记语言文件。
37.在第二方面的可选实施例中，文件生成模块在基于解析后的json文件生成更新文件对应的标记语言文件时，具体用于：
38.确定解析后的json文件对应的目标模板；
39.基于解析后的json文件和目标模板生成更新文件对应的标记语言文件。
40.在第二方面的可选实施例中，文件生成模块在解析后的json文件包括更新文件对应的模板标识以及更新内容，确定解析后的json文件对应的目标模板时，具体用于：
41.对预设的语义模板库进行检测；
42.若语义模板库中存在模板标识对应的模板，则将模板标识对应的模板作为更新文件对应的目标模板；
43.若语义模板库中不存在模板标识对应的模板，向更新文件对应的目标客户端发送提示信息；接收目标客户端返回的模板配置信息，基于模板配置信息生成更新文件对应的目标模板；目标客户端为向代码远程仓库提交更新文件的客户端，提示信息用于提示语义模板库中不存在与更新文件对应的模板。
44.在第二方面的可选实施例中，装置还包括：
45.第二监听模块，用于对文档远程仓库进行监听，若文档远程仓库基于标记语言文件更新接口文档，则从文档远程仓库获取更新后的接口文档；
46.接口配置模块，用于基于接口文档对至少一个接口进行配置值；
47.文档发送模块，用于响应于接收到的接口文档查看请求，将接口文档发送接口文档查看请求对应的客户端，以使客户端可以基于接口文档渲染并更新各客户端的文档显示界面；文档显示界面用于显示至少一个接口的接口配置参数。
48.第三方面，提供了一种电子设备，该电子设备包括：
49.存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，处理器执行程序时实现上述任一实施例的接口文档更新方法。
50.第四方面，提供了一种计算机可读存储介质，计算机可读存储介质上存储有计算机程序，该程序被处理器执行时实现上述任一实施例的接口文档更新方法。
51.第五方面，提供了一种计算机程序产品或计算机程序，该计算机程序产品或计算机程序包括计算机指令，该计算机指令存储在计算机可读存储介质中。计算机设备的处理器从计算机可读存储介质读取该计算机指令，处理器执行该计算机指令，使得该计算机设备执行时实现第一方面实施例中所提供的方法。
52.上述的接口文档更新方法，通过监听代码远程仓库，当代码远程仓库接收到更新文件时，从代码远程仓库获取更新文件，更新文件中包括针对至少一个接口的接口配置参数的更新内容。然后基于更新文件生成更新文件对应的标记语言文件，并将标记语言文件发送至文档远程仓库，使文档远程仓库可以基于标记语言文件更新标记语言文件对应的接口文档。本技术所提供的接口文档更新方法，通过监听代码远程仓库，在接收到更新文件时自动触发更新流程，将更新文件转化为标记语言文件，并发送至文档远程仓库对相应的接口文档进行更新，提高了接口文档更新效率。
附图说明
53.图1为本技术实施例提供的一种接口文档更新方法的流程示意图；
54.图2为本技术实施例提供的一种接口文档更新方法的流程示意图；
55.图3为本技术实施例提供的一种接口文档更新装置的结构示意图；
56.图4为本技术实施例提供的一种用于接口文档更新的电子设备的结构示意图。
具体实施方式
57.下面结合本技术中的附图描述本技术的实施例。应理解，下面结合附图所阐述的实施方式，是用于解释本技术实施例的技术方案的示例性描述，对本技术实施例的技术方案不构成限制。
58.本技术领域技术人员可以理解，除非特意声明，这里使用的单数形式“一”、“一个”、“所述”和“该”也可包括复数形式。应该进一步理解的是，本技术实施例所使用的术语“包括”以及“包含”是指相应特征可以实现为所呈现的特征、信息、数据、步骤、操作、元件和/或组件，但不排除实现为本技术领域所支持其他特征、信息、数据、步骤、操作、元件、组件和/或它们的组合等。应该理解，当我们称一个元件被“连接”或“耦接”到另一元件时，该一个元件可以直接连接或耦接到另一元件，也可以指该一个元件和另一元件通过中间元件建立连接关系。此外，这里使用的“连接”或“耦接”可以包括无线连接或无线耦接。这里使用的术语“和/或”指示该术语所限定的项目中的至少一个，例如“a和/或b”可以实现为“a”，或者实现为“b”，或者实现为“a和b”。
59.为使本技术的目的、技术方案和优点更加清楚，下面将结合附图对本技术实施方式作进一步地详细描述。
60.首先对本技术涉及的几个名词进行介绍和解释：
61.api(application programming interface，应用程序接口)：一些预先定义的接口，或指软件系统不同组成部分衔接的约定，用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。
62.api文档(接口文档)：对所有、接口的调用和其中涉及到的接口配置参数的清晰的解释说明。
63.webhook(钩子)：一个api概念，是微服务api的使用范式之一，也被成为反向api，即前端不主动发送请求，完全由后端推送或者处理。更为广泛的应用方法可以理解为，对a进行监听，监听到某指定事件发生后，由b执行预先设定的任务。
64.下面通过对几个示例性实施方式的描述，对本技术实施例的技术方案以及本技术的技术方案产生的技术效果进行说明。需要指出的是，下述实施方式之间可以相互参考、借鉴或结合，对于不同实施方式中相同的术语、相似的特征以及相似的实施步骤等，不再重复描述。
65.本技术实施例中提供了一种接口文档更新方法，如图1所示，该方法可以应用于服务器，可以包括如下步骤：
66.步骤s101，对代码远程仓库进行监听，当所述代码远程仓库接收到更新文件时，从代码远程仓库获取更新文件；更新文件包括针对至少一个接口的接口配置参数的更新内容。
67.其中，远程仓库可以是指托管在因特网或其他网络中的项目的版本库。而代码远程仓库可以同于存放不同版本的代码文件。本技术中的代码仓库可以是专门用于存放接口配置相关的代码的远程仓库。
68.更新文件的本质可以是包括针对至少一个接口的接口配置参数的更新内容的代码文件。当研发人员将更新文件编写完成，可以通过git(分布式版本控制系统)将更新文件提交到代码远程仓库。
69.可以对代码远程仓库进行监听，当监听到代码远程仓库接收到更新文件时，可以从代码远程仓库获取更新文件。具体的，在实际应用场景中，可以使用webhook技术对代码远程仓库进行监听。
70.在本技术实施例中，当所述代码远程仓库接收到更新文件时，从所述代码远程仓库获取所述更新文件，可以包括如下步骤：
71.(1)接收代码远程仓库通过预设的事件处理接口发送的更新触发信息，更新触发信息为代码远程仓库在接收到更新文件时发送的。
72.其中，更新触发信息可以是预设的简单字符，也可以包含发送时间等更多信息，本技术不作限制。更新触发信息可以用于指示被监听的代码远程仓库触发了指定事件，而指定事件在本技术中可以是代码远程仓库接收到了更新文件。
73.在实际应用场景中，可以使用webhook技术对代码远程仓库进行监听，具体实现方法可以如下：在代码远程仓库中留下url(uniform resource locator,统一资源定位器)，即预先设置事件处理接口，并将指定事件作为触发事件，本实施例中的触发事件可以是代码远程仓库接收到更新文件；对代码远程仓库进行监听，当监听到代码远程仓库接收到更新文件时，代码远程仓库通过url向服务器发送更新触发信息，服务器接收到更新触发信息后，从代码远程仓库获取更新文件。
74.(2)响应于接收到的所述更新触发信息，向代码远程仓库发送更新文件获取请求，以从所述代码远程仓库获取所述更新文件。
75.在另一些实施例中，当监听到代码远程仓库接收到更新文件时，代码远程仓库向服务器发送的更新触发信息后，可以由代码远程仓库直接向服务器发送更新文件，或者直接将更新文件放入更新触发信息中，对此，本技术并不做限制。
76.步骤s102，基于更新文件生成更新文件对应的标记语言文件。其中，标记语言文件可以通过预设的标记语言记录更新文件对应的更新内容。
77.具体的，标记语言可以是markdown语言。markdown是一种用来写作的轻量级标记语言，它可以用简洁的语法代替排版，具有易写易读的优点。
78.而标记语言文件可以是markdown文件，更新文件对应的标记语言文件中通过预设的标记语言记录了更新文件对应的更新内容。
79.在本技术实施例中，并不限制更新文件的语言。
80.在一个示例中，更新文件可以是typescript源码文件，typescript是微软开发和维护的一种面向对象的编程语言，可以使用类型和接口等概念来描述正在使用的数据，这使开发人员能够快速检测错误并调试应用程序。
81.基于更新文件生成更新文件对应的标记语言文件的过程可以为：先将typescript源码文件转换为json文件，再将json文件转换为markdown文件，转换方法将在后文详细说
明。
82.在本技术实施例中，基于更新文件生成更新文件对应的标记语言文件，可以包括如下步骤：
83.(1)对更新文件进行解析得到解析结果，基于解析结果生成更新文件对应的json文件。
84.其中，可以通过与更新文件语言相适应的插件或者工具对更新文件进行解析，基于解析结果生成更新文件对应的json文件。
85.具体的，当更新文件是typescript源码文件时，可以通过typedoc(一种支持typescript的文档生成工具)对更新文件进行扫描，对更新文件(typescript源码文件)中的注释以及源码进行解析，生成更新文件对应的json文件。更新文件对应的json文件以一种更为简洁、清晰的格式表述更新文件对应的更新内容。
86.(2)调用预设的代码处理平台对json文件进行解析，基于解析后的json文件生成更新文件对应的标记语言文件。
87.本技术实施例中，代码处理平台可以包括任何可以对json文件进行解析的平台、插件和工具应用程序，本技术对代码处理平台不做限制。
88.在一个示例中，预设的代码处理平台可以是node.js(一种用于服务器端的javascript的处理平台)，可以通过node.js对json文件进行解析，解析的作用是将json文件内的字符串内容转化为json对象的形式，便于阅读和取值。
89.可以基于解析后的json文件生成更新文件对应的标记语言文件。在本示例中，可以基于解析后的json文件生成更新文件对应的markdown文件。
90.在本技术实施例中，基于解析后的json文件生成所述更新文件对应的标记语言文件，可以包括如下步骤：确定解析后的json文件对应的目标模板；基于解析后的json文件和目标模板生成更新文件对应的标记语言文件。
91.具体的，可以通过handlebar(一种javascript的语义模板库)基于解析后的json文件生成更新文件对应的markdown文件。其中，可以先确定解析后的json文件对应的目标模板，然后基于基于解析后的json文件和目标模板生成更新文件对应的markdown文件。
92.在本技术实施例中，解析后的json文件可以包括更新文件对应的模板标识以及更新内容，则确定解析后的json文件对应的目标模板，可以包括如下步骤：
93.对预设的语义模板库进行检测；
94.若语义模板库中存在模板标识对应的模板，则将模板标识对应的模板作为更新文件对应的目标模板；
95.若语义模板库中不存在模板标识对应的模板，向更新文件对应的目标客户端发送提示信息；接收目标客户端返回的模板配置信息，基于模板配置信息生成更新文件对应的目标模板；目标客户端为向代码远程仓库提交更新文件的客户端，提示信息用于提示语义模板库中不存在与更新文件对应的模板。
96.在实际应用场景中，语义模板库可以是指handlebars，当handlebars中不存在与更新文件对应的模板时，可以向提交更新文件的研发人员的目标客户端发送提示信息，并接收目标客户端返回的模板配置信息，基于模板配置信息生成更新文件对应的目标模板，将生成的目标模板的模板标识设为解析后的json文件中的模板标识，并将生成的模板存储
于语义模板库，便于下次再次调用。
97.步骤s103，将标记语言文件发送至文档远程仓库，以使文档远程仓库基于标记语言文件更新标记语言文件对应的接口文档中的至少一个接口的接口配置参数。
98.在本技术实施例中，当文档远程仓库接收到服务器提交的标记语言文件时，若文档远程仓库存在项目管理员，则项目管理员可以对提交的标记语言文件进行审核，若审核通过，项目管理员可以给出更新指令，使文档远程仓库根据标记语言文件更新标记语言文件对应的接口文档，具体可以是对接口文档中与标记语言文件中包含的更新内容对应的至少一个接口的接口配置参数进行更新，本技术中的更新操作可以是根据标记语言文件对接口文档进行局部更新，也可以是基于标记语言文件生成新的接口文档，对旧的接口文档进行覆盖，本技术不作限制。
99.若文档远程仓库不存在项目管理员，则文档远程仓库接收到标记语言文件时，可以自动基于标记语言文件更新标记语言文件对应的接口文档中的至少一个接口的接口配置参数。
100.在本技术实施例中，接口文档可以为markdown文件。
101.上述的接口文档更新方法，通过监听代码远程仓库，当代码远程仓库接收到更新文件时，从代码远程仓库获取更新文件，更新文件中包括针对至少一个接口的接口配置参数的更新内容。然后基于更新文件生成更新文件对应的标记语言文件，并将标记语言文件发送至文档远程仓库，使文档远程仓库可以基于标记语言文件更新标记语言文件对应的接口文档。本技术所提供的接口文档更新方法，通过监听代码远程仓库，在接收到更新文件时自动触发更新流程，将更新文件转化为标记语言文件，并发送至文档远程仓库对相应的接口文档进行更新，提高了接口文档更新效率。
102.本技术实施例中提供了一种可能的实现方式，本技术提供的接口文档更新方法还包括以下步骤：
103.(1)对文档远程仓库进行监听，若文档远程仓库基于标记语言文件更新接口文档，则从文档远程仓库获取更新后的接口文档；
104.其中，更新后的接口文档相较于更新文件对应的标记语言文件，不仅包含更新内容，还可以包含与更新内容存在关联的、需要同步进行重新部署的内容。
105.(2)基于接口文档对至少一个接口进行配置。
106.可以对接口文档进行镜像部署，具体的，可以基于接口文档对至少一个接口进行配置，其中，至少一个接口可以是与更新内容相关联的接口，也可以是全部接口，本技术不做限制。
107.(3)响应于接收到的接口文档查看请求，将更新后的接口文档发送接口文档查看请求对应的客户端，以使客户端可以基于更新后的接口文档渲染并更新各客户端的文档显示界面；文档显示界面用于显示至少一个接口的接口配置参数。
108.当接收到任一与服务器连接的客户端发送的接口文档查看请求时，可以将更新后的接口文档发送至该请求对应的客户端，使客户端可以通过渲染引擎基于更新后的接口文档渲染并更新客户端的文档显示界面，用户可以在文档显示界面看到更新后的各个接口的接口配置参数。
109.在本技术实施例中，可以通过docsify(文档网站生成工具)解析更新后的接口文
档，并对客户端的文档显示界面进行动态渲染。
110.在一个示例中，如图2所示，本技术提供的接口文档更新方法可包括如下步骤：
111.步骤s201，对代码远程仓库进行监听，当代码远程仓库接收到更新文件时，接收代码远程仓库通过预设的事件处理接口发送的更新触发信息，更新触发信息为代码远程仓库在接收到更新文件时发送的；
112.步骤s202，响应于接收到的更新触发信息，向代码远程仓库发送更新文件获取请求，以从代码远程仓库获取更新文件，更新文件包括针对至少一个接口的接口配置参数的更新内容；
113.步骤s203，对更新文件进行解析得到解析结果，基于解析结果生成更新文件对应的json文件；
114.步骤s204，调用预设的代码处理平台对json文件进行解析，得到解析后的json文件；
115.步骤s205，对预设的语义模板库进行检测；
116.其中，若语义模板库中存在模板标识对应的模板，则将模板标识对应的模板作为更新文件对应的目标模板；
117.若语义模板库中不存在模板标识对应的模板，向更新文件对应的目标客户端发送提示信息；接收目标客户端返回的模板配置信息，基于模板配置信息生成更新文件对应的目标模板；目标客户端为向代码远程仓库提交更新文件的客户端，提示信息用于提示语义模板库中不存在与更新文件对应的模板；
118.步骤s206，基于解析后的json文件和目标模板生成更新文件对应的标记语言文件；
119.步骤s207，将标记语言文件发送至文档远程仓库，以使文档远程仓库基于标记语言文件更新标记语言文件对应的接口文档；
120.步骤s208，对文档远程仓库进行监听，若文档远程仓库基于标记语言文件更新接口文档，则从文档远程仓库获取更新后的接口文档；
121.步骤s209，基于更新后的接口文档对至少一个接口进行配置；
122.步骤s210，响应于接收到的接口文档查看请求，将更新后的接口文档发送至接口文档查看请求对应的客户端，以使客户端可以基于更新后的接口文档渲染并更新客户端的文档显示界面；文档显示界面用于显示至少一个接口的接口配置参数。
123.为了更清楚阐释本技术的接口文档更新方法，以下将结合具体示例对接口文档更新方法进行进一步说明。
124.本技术提供了一种接口文档更新方法，可以实现为一个api文档自动更新系统，该系统可以包括客户端部分和服务器部分，其中，客户端部分用于与研发人员进行交互，服务器部分用于接收客户端发送的更新代码，并基于更新代码生成相应的标记语言文件，将标记语言文件发送至文档远程仓库，以使文档远程仓库基于标记语言文件更新标记语言文件对应的接口文档。其中，客户端部分和服务器部分可以根据项目需求分别部署相应的平台或者工具插件，而api文档自动更新系统可以自动调用平台或者工具插件完成相应的步骤。
125.在一个示例中，本技术提供的接口文档更新方法可以包括以下步骤：
126.步骤s01，对api代码远程仓库进行监听；当开发人员通过git(分布式版本控制系
统)将更新文件提交到api代码远程仓库时，服务器可以获取到api代码远程仓库的服务器或者终端设备通过预设的事件处理接口发送的更新触发信息。其中，更新文件可以是包含有新增、删除或者更改后的部分代码或者是针对某应用或者某文件更改后的全部代码。远程仓库可以是指托管在因特网或其他网络中的该开发人员所属的各个项目的版本库，可以实现与他人协作涉及管理远程仓库以及根据需要推送或拉取数据。在实际应用场景中，可以使用webhook对api代码远程仓库进行监听。
127.步骤s02，响应于接收到的更新触发信息，从api代码远程仓库中获取更新文件，并对更新文件进行扫描和解析，并基于解析后的更新文件生成包含了更新内容的json(javascript object notation，轻量级的数据交换格式)文件。其中，在实际应用场景中，当更新文件用不同语言进行编写时，可以调用不同的文档工具，实现将更新文件转换为json文件。例如，当更新文件为typescript源代码(typescript是一种面向对象的编程语言，可以便捷地对关键信息进行注释)时，可以用typedoc(支持typescript的文档生成工具)扫描更新文件，对更新文件进行解析，并基于解析后的更新文件以及更新文件中的注释内容生成包含更新内容的json文件。
128.步骤s03，对包含更新内容的json文件进行解析，并根据解析后的json文件生成标记语言文件。具体的，可以使用node.js平台(一种服务器端的javascript处理平台)解析json文件，通过handlebar(一种javascript语义模板库)基于解析后的json文件生成标记语言文件，其中，标记语言文件可以为markdown文件，标记语言文件中可以包含更新内容，即更新后的接口配置参数，可以用于对更新文件对应的至少一个服务器进行镜像部署，还可以用于渲染并在各个客户端的应用界面中显示更新后的接口配置参数对应的各个接口的调用方法以及各个接口涉及到的参数的解释说明。markdown是一种用来写作的轻量级标记语言，它用简洁的语法代替排版。在实际应用场景中，标记语言文件的语言可以根据渲染引擎能够识别的语言决定，本技术不做限制。
129.其中，通过handlebar基于解析后的json文件生成标记语言文件可以包括如下步骤：确定或者生成与解析后的json文件对应的目标模板；将解析后的json文件作为目标模板的输入对象，生成标记语言文件，标记语言文件的文本格式可以为markdown格式。
130.步骤s04，将标记语言文件发送至api文档远程仓库。具体的，可以通过node.js平台将标记语言文件提交至api文档远程仓库。
131.步骤s05，对api文档远程仓库进行持续监听，当api文档远程仓库存储标记语言文件，并基于标记语言文件对标记语言文件对应的接口文档进行更新时，从api文档远程仓库的服务器或者终端设备获取更新后的接口文档，执行部署脚本，对更新后的接口文档进行镜像部署，使更新文件对应的至少一个服务器根据更新后的接口文档的接口配置参数进行配置。具体的，可以通过webhook监听api文档远程仓库。
132.步骤s06，响应于接收到的接口文档查看请求，将更新后的接口文档发送至接口文档查看请求对应的客户端，以使客户端可以基于更新后的接口文档渲染并更新客户端的文档显示界面；文档显示界面用于显示至少一个接口的接口配置参数、调用方法以及各个接口涉及到的参数的解释说明。
133.本技术实施例提供了一种接口文档更新装置，如图3所示，该接口文档更新装置30可以包括：第一监听模块301、文件生成模块302以及文档更新模块303，其中，
134.第一监听模块301，用于对代码远程仓库进行监听，当代码远程仓库接收到更新文件时，从代码远程仓库获取更新文件；更新文件包括针对至少一个接口的接口配置参数的更新内容；
135.文件生成模块302，用于基于更新文件生成更新文件对应的标记语言文件；
136.文档更新模块303，用于将标记语言文件发送至文档远程仓库，以使文档远程仓库基于标记语言文件更新标记语言文件对应的接口文档。
137.上述的接口文档更新装置，通过监听代码远程仓库，当代码远程仓库接收到更新文件时，从代码远程仓库获取更新文件，更新文件中包括针对至少一个接口的接口配置参数的更新内容。然后基于更新文件生成更新文件对应的标记语言文件，并将标记语言文件发送至文档远程仓库，使文档远程仓库可以基于标记语言文件更新标记语言文件对应的接口文档。本技术所提供的接口文档更新方法，通过监听代码远程仓库，在接收到更新文件时自动触发更新流程，将更新文件转化为标记语言文件，并发送至文档远程仓库对相应的接口文档进行更新，提高了接口文档更新效率。
138.在本技术实施例中，第一监听模块301在当代码远程仓库接收到更新文件时，从代码远程仓库获取更新文件时，具体用于：
139.接收代码远程仓库通过预设的事件处理接口发送的更新触发信息，更新触发信息为代码远程仓库在接收到更新文件时发送的；
140.响应于接收到的更新触发信息，向代码远程仓库发送更新文件获取请求，以从代码远程仓库获取更新文件。
141.在本技术实施例中，文件生成模块302在基于更新文件生成更新文件对应的标记语言文件时，具体用于：
142.对更新文件进行解析得到解析结果，基于解析结果生成更新文件对应的json文件；
143.调用预设的代码处理平台对json文件进行解析，基于解析后的json文件生成更新文件对应的标记语言文件。
144.在本技术实施例中，文件生成模块302在基于解析后的json文件生成更新文件对应的标记语言文件时，具体用于：
145.确定解析后的json文件对应的目标模板；
146.基于解析后的json文件和目标模板生成更新文件对应的标记语言文件。
147.在本技术实施例中，文件生成模块302在解析后的json文件包括更新文件对应的模板标识以及更新内容，确定解析后的json文件对应的目标模板时，具体用于：
148.对预设的语义模板库进行检测；
149.若语义模板库中存在模板标识对应的模板，则将模板标识对应的模板作为更新文件对应的目标模板；
150.若语义模板库中不存在模板标识对应的模板，向更新文件对应的目标客户端发送提示信息；接收目标客户端返回的模板配置信息，基于模板配置信息生成更新文件对应的目标模板；目标客户端为向代码远程仓库提交更新文件的客户端，提示信息用于提示语义模板库中不存在与更新文件对应的模板。
151.在本技术实施例中，装置还包括：
152.第二监听模块，用于对文档远程仓库进行监听，若文档远程仓库基于标记语言文件更新接口文档，则从文档远程仓库获取更新后的接口文档；
153.接口配置模块，用于基于接口文档对至少一个接口进行配置值；
154.文档发送模块，用于响应于接收到的接口文档查看请求，将接口文档发送接口文档查看请求对应的客户端，以使客户端可以基于接口文档渲染并更新各客户端的文档显示界面；文档显示界面用于显示至少一个接口的接口配置参数。
155.本技术实施例的装置可执行本技术实施例所提供的方法，其实现原理相类似，本技术各实施例的装置中的各模块所执行的动作是与本技术各实施例的方法中的步骤相对应的，对于装置的各模块的详细功能描述具体可以参见前文中所示的对应方法中的描述，此处不再赘述。
156.本技术实施例中提供了一种电子设备(计算机装置/设备/系统)，包括存储器、处理器及存储在存储器上的计算机程序，该处理器执行上述计算机程序以实现业务处理方法的步骤，与相关技术相比可实现：通过监听代码远程仓库，在接收到更新文件时自动触发更新流程，将更新文件转化为标记语言文件，并发送至文档远程仓库对相应的接口文档进行更新，提高了接口文档更新效率。
157.在一个可选实施例中提供了一种电子设备，如图4所示，图4所示的电子设备4000包括：处理器4001和存储器4003。其中，处理器4001和存储器4003相连，如通过总线4002相连。可选地，电子设备4000还可以包括收发器4004，收发器4004可以用于该电子设备与其他电子设备之间的数据交互，如数据的发送和/或数据的接收等。需要说明的是，实际应用中收发器4004不限于一个，该电子设备4000的结构并不构成对本技术实施例的限定。
158.处理器4001可以是cpu(central processing unit，中央处理器)，通用处理器，dsp(digital signal processor，数据信号处理器)，asic(application specific integrated circuit，专用集成电路)，fpga(field programmable gate array，现场可编程门阵列)或者其他可编程逻辑器件、晶体管逻辑器件、硬件部件或者其任意组合。其可以实现或执行结合本技术公开内容所描述的各种示例性的逻辑方框，模块和电路。处理器4001也可以是实现计算功能的组合，例如包含一个或多个微处理器组合，dsp和微处理器的组合等。
159.总线4002可包括一通路，在上述组件之间传送信息。总线4002可以是pci(peripheral component interconnect，外设部件互连标准)总线或eisa(extended industry standard architecture，扩展工业标准结构)总线等。总线4002可以分为地址总线、数据总线、控制总线等。为便于表示，图4中仅用一条粗线表示，但并不表示仅有一根总线或一种类型的总线。
160.存储器4003可以是rom(read only memory，只读存储器)或可存储静态信息和指令的其他类型的静态存储设备，ram(random access memory，随机存取存储器)或者可存储信息和指令的其他类型的动态存储设备，也可以是eeprom(electrically erasable programmable read only memory，电可擦可编程只读存储器)、cd-rom(compact disc read only memory，只读光盘)或其他光盘存储、光碟存储(包括压缩光碟、激光碟、光碟、数字通用光碟、蓝光光碟等)、磁盘存储介质、其他磁存储设备、或者能够用于携带或存储计算机程序并能够由计算机读取的任何其他介质，在此不做限定。
161.存储器4003用于存储执行本技术实施例的计算机程序，并由处理器4001来控制执行。处理器4001用于执行存储器4003中存储的计算机程序，以实现前述方法实施例所示的步骤。
162.其中，电子设备包括但不限于：移动电话、笔记本电脑、pad等等移动终端以及诸如数字tv、台式计算机等等固定终端。
163.本技术实施例提供了一种计算机可读存储介质，该计算机可读存储介质上存储有计算机程序，计算机程序被处理器执行时可实现前述方法实施例的步骤及相应内容。
164.本技术实施例还提供了一种计算机程序产品，包括计算机程序，计算机程序被处理器执行时可实现前述方法实施例的步骤及相应内容。
165.本技术的说明书和权利要求书及上述附图中的术语“第一”、“第二”、“第三”、“第四”、“1”、“2”等(如果存在)是用于区别类似的对象，而不必用于描述特定的顺序或先后次序。应该理解这样使用的数据在适当情况下可以互换，以便这里描述的本技术的实施例能够以除图示或文字描述以外的顺序实施。
166.应该理解的是，虽然本技术实施例的流程图中通过箭头指示各个操作步骤，但是这些步骤的实施顺序并不受限于箭头所指示的顺序。除非本文中有明确的说明，否则在本技术实施例的一些实施场景中，各流程图中的实施步骤可以按照需求以其他的顺序执行。此外，各流程图中的部分或全部步骤基于实际的实施场景，可以包括多个子步骤或者多个阶段。这些子步骤或者阶段中的部分或全部可以在同一时刻被执行，这些子步骤或者阶段中的每个子步骤或者阶段也可以分别在不同的时刻被执行。在执行时刻不同的场景下，这些子步骤或者阶段的执行顺序可以根据需求灵活配置，本技术实施例对此不限制。
167.以上所述仅是本技术部分实施场景的可选实施方式，应当指出，对于本技术领域的普通技术人员来说，在不脱离本技术的方案技术构思的前提下，采用基于本技术技术思想的其他类似实施手段，同样属于本技术实施例的保护范畴。