(19)国家知识产权局 (12)发明 专利申请 (10)申请公布号 (43)申请公布日 (21)申请 号 202210125566.1 (22)申请日 2022.02.10 (66)本国优先权数据 20221010252 2.7 2022.01.27 CN (71)申请人 厦门雅基软件 有限公司 地址 361021 福建省厦门市集美区集美大 道1302号创业大厦六层6 07单元之三 (72)发明人 曹啟森　李楠　王嘉宁　林顺　 (74)专利代理 机构 北京市立方律师事务所 11330 专利代理师 张筱宁 (51)Int.Cl. G06F 16/84(2019.01) G06F 16/28(2019.01) G06F 16/25(2019.01)G06F 16/23(2019.01) (54)发明名称 接口文档更新方法、 装置、 电子设备及可读 存储介质 (57)摘要 本申请实施例提供了一种接口文档更新方 法、 装置、 电子设备及可读存储介质， 涉及计算机 技术领域。 该方法包括： 通过监听代码远程仓库， 当代码远程仓库接收到更新文件时， 从代码远程 仓库获取更新文件， 更新文件中包括针对至少一 个接口的接口配置参数的更新内容； 然后基于更 新文件生 成更新文件对应的标记语 言文件， 并将 标记语言文件发送至文档远程仓库， 使文档远程 仓库可以基于标记语言文件更新标记语言文件 对应的接口文档。 本申请所提供的接口文档更新 方法， 通过监听代码远程仓库， 在接收到更新文 件时自动触发更新流程， 将更新文件转化为标记 语言文件， 并发送至文档远程仓库对相应的接口 文档进行 更新， 提高了 接口文档更新效率。 权利要求书2页 说明书12页 附图3页 CN 114443905 A 2022.05.06 CN 114443905 A 1.一种接口文档更新方法， 其特 征在于， 包括： 对代码远程仓库进行监听， 当所述代码远程仓库接收到更新文件时， 从所述代码远程 仓库获取所述更新文件； 所述更新文件包括针对至少一个接口的接口配置参数的更新内 容； 基于所述更新文件生成所述更新文件 对应的标记语言文件； 将所述标记语言文件发送至文档远程仓库， 以使所述文档远程仓库基于所述标记语言 文件更新所述标记语言文件 对应的接口文档。 2.根据权利要求1所述的接口文档更新方法， 其特征在于， 所述当所述代码远程仓库接 收到更新文件时， 从所述代码远程仓库获取 所述更新文件， 包括： 接收所述代码远程仓库通过预设的事件处理接口发送的更新触发信 息， 所述更新触发 信息为所述代码远程仓库在接收到所述更新文件时发送的； 响应于接收到的所述更新触发信息， 向所述代码远程仓库发送更新文件获取请求， 以 从所述代码远程仓库获取 所述更新文件。 3.根据权利要求1所述的接口文档更新方法， 其特征在于， 所述基于所述更新文件生成 所述更新文件 对应的标记语言文件， 包括： 对所述更新文件进行解析得到解析结果， 基于所述解析结果生成所述更新文件对应的 JSON文件； 调用预设的代码处理平台对所述JSON文件进行解析， 基于解析后的JSON文件生成所述 更新文件 对应的标记语言文件。 4.根据权利要求3所述的接口文档更新方法， 其特征在于， 所述基于解析后的JSON文件 生成所述更新文件 对应的标记语言文件， 包括： 确定所述 解析后的JSON文件 对应的目标模板； 基于所述解析后的JSON文件和所述目标模板生成所述更新文件对应的所述标记语言 文件。 5.根据权利要求4所述的接口文档更新方法， 其特征在于， 所述解析后的JSON文件包括 所述更新文件对应的模板标识以及更新内容， 所述确定所述解析后的JSON文件对应的目标 模板， 包括： 对预设的语义模板库进行检测； 若所述语义模板库中存在所述模板标识对应的模板， 则将所述模板标识对应的模板作 为所述更新文件 对应的目标模板； 若所述语义模板库中不存在所述模板标识对应的模板， 向所述更新文件对应的目标客 户端发送提示信息； 接 收所述目标客户端返回的模板配置信息， 基于所述模板配置信息生 成更新文件对应的目标模板； 所述目标客户端为向所述代码 远程仓库提交所述更新文件的 客户端， 所述 提示信息用于提 示所述语义模板库中不存在与所述更新文件 对应的模板 。 6.根据权利要求1 ‑5任一项所述的接口文档更新方法， 其特 征在于， 所述方法还 包括： 对所述文档远程仓库进行监 听， 若所述文档远程仓库基于所述标记语言文件更新接口 文档， 则从所述文档远程仓库获取 更新后的接口文档； 基于所述更新后的接口文档对所述至少一个接口进行配置； 响应于接收到的接口文档查看请求， 将所述更新后的接口文档发送至所述接口文档查权　利　要　求　书 1/2 页 2 CN 114443905 A 2看请求对应的客户端， 以使所述客户端可以基于所述更新后的接口文档渲染并更新所述客 户端的文档显示界面； 所述文档显示界面用于 显示所述至少一个接口 的接口配置参数。 7.一种接口文档更新装置， 其特 征在于， 包括： 第一监听模块， 用于对代码远程仓库进行监听， 当所述代码远程仓库接收到更新文件 时， 从所述代码远程仓库获取所述更新文件； 所述更新文件包括针对至少一个接口的接口 配置参数的更新内容； 文件生成模块， 用于基于所述更新文件生成所述更新文件 对应的标记语言文件； 文档更新模块， 用于将所述标记语言文件发送至文档远程仓库， 以使所述文档远程仓 库基于所述标记语言文件更新所述标记语言文件 对应的接口文档。 8.根据权利要求7 所述的接口文档更新装置， 其特 征在于， 所述装置还 包括： 第二监听模块， 用于对所述文档远程仓库进行监听， 若所述文档远程仓库基于所述标 记语言文件更新接口文档， 则从所述文档远程仓库获取 更新后的接口文档； 接口配置模块， 用于基于所述接口文档对所述至少一个接口进行配置值； 文档发送模块， 用于响应于接收到的接口文档查看请求， 将所述接口文档发送所述接 口文档查看请求对应的客户端， 以使 所述客户端 可以基于接口文档渲染并更新各客户端的 文档显示界面； 所述文档显示界面用于 显示所述至少一个接口 的接口配置参数。 9.一种电子设备， 包括存储器、 处理器及存储在存储器上的计算机程序， 其特征在于， 所述处理器执行所述计算机程序以实现权利要求1 ‑6任一项所述方法的步骤。 10.一种计算机可读存储介质， 其上存储有计算机程序， 其特征在于， 所述计算机程序 被处理器执行时实现权利要求1 ‑6任一项所述的接口文档更新方法的步骤。权　利　要　求　书 2/2 页 3 CN 114443905 A 3