接口文档生成方法、装置、设备、介质及产品与流程
本发明涉及计算机,尤其涉及一种接口文档生成方法、装置、设备、介质及产品。
背景技术:
1、在敏捷开发的软件工程实践中,应用程序接口的变动日益频繁,对接口文档的及时性和准确性提出了更高要求。当前主流方式依赖开发人员手动维护文档,不仅人力成本高、更新滞后,还容易因疏漏导致文档与实际代码行为不一致。此外,现有接口文档的更新机制多基于固定时间点或人工触发,难以实时响应代码库的变动,在快速迭代环境下难以保障接口文档的时效性与准确性,进而影响开发与运维效率。
技术实现思路
1、本发明实施例的目的在于提供一种接口文档生成方法、装置、设备、介质及产品,以提升接口文档的时效性、准确性与生成效率。具体技术方案如下:
2、在本发明实施的第一方面,首先提供了一种接口文档生成方法,所述方法包括:
3、响应于监听到所述合并请求,获取第一代码文本和第二代码文本;其中,所述合并请求为将源分支代码合并至目标分支的请求;所述第一代码文本为所述目标分支对应的代码文本,所述第二代码文本为所述源分支代码与所述目标分支的代码相比变更的代码文本;
4、通过文档生成模型基于所述第一代码文本、所述第二代码文本和历史接口业务逻辑文本,生成接口文档;其中,所述历史接口业务逻辑文本为监听到所述合并请求之前用于描述接口的业务逻辑的文本;所述接口文档用于描述将所述第二代码文本合并至所述第一代码文本后所得代码对应的业务逻辑。
5、在本发明实施的第二方面,还提供了一种接口文档生成装置,所述装置包括:
6、代码获取模块,用于响应于监听到所述合并请求,获取第一代码文本和第二代码文本;其中,所述合并请求为将源分支代码合并至目标分支的请求;所述第一代码文本为所述目标分支对应的代码文本,所述第二代码文本为所述源分支代码与所述目标分支的代码相比变更的代码文本;
7、文本生成模块,用于通过文档生成模型基于所述第一代码文本、所述第二代码文本和历史接口业务逻辑文本,生成用于描述所述源分支代码的业务逻辑的接口文档;其中,所述历史接口业务逻辑文本为监听到所述合并请求之前用于描述接口的业务逻辑的文本;所述接口文档用于描述将所述第二代码文本合并至所述第一代码文本后所得代码对应的业务逻辑。
8、在本发明实施的第三方面,还提供了一种电子设备,所述电子设备包括:
9、处理器;
10、用于存储所述处理器可执行指令的存储器;
11、所述处理器,用于从所述存储器中读取所述可执行指令,并执行所述指令以实现上述接口文档生成方法。
12、在本发明实施的第四方面,还提供了一种计算机可读存储介质,所述存储介质存储有计算机程序,所述计算机程序用于执行上述接口文档生成方法。
13、在本发明实施的第五方面,还提供了一种计算机程序产品,当所述计算机程序产品在计算机上运行时,使得所述计算机实现上述接口文档生成方法。
14、本发明实施例提供的技术方案与现有技术相比具有如下优点:
15、本发明实施例提供的技术方案包括:响应于监听到合并请求,获取第一代码文本和第二代码文本;其中,合并请求为将源分支代码合并至目标分支的请求;第一代码文本为目标分支对应的代码文本,第二代码文本为源分支代码与目标分支的代码相比变更的代码文本;通过文档生成模型基于第一代码文本、第二代码文本和历史接口业务逻辑文本,生成接口文档;其中,历史接口业务逻辑文本为监听到合并请求之前用于描述接口的业务逻辑的文本;接口文档用于描述将第二代码文本合并至第一代码文本后所得代码对应的业务逻辑。
16、本技术方案以监听合并请求作为触发机制,确保在源分支代码即将合入目标分支时及时启动文档更新流程,避免无效处理。通过响应监听到的合并请求,获取第一代码文本与第二代码文本,由第一代码文本提供目标分支的完整代码,由第二代码文本提供当前变更的增量代码内容,二者共同构成对当前完整的代码状态与代码变化范围的准确刻画,为文档生成模型理解改了什么和原来什么样奠定数据基础。同时,还利用历史接口业务逻辑文本提供变更前的业务语义基线,使文档生成模型不仅能够知晓代码层面的变化,还能够确定变更对既有业务规则的影响范围和程度,从而在生成接口文档时既能够保留原有合理的业务描述,又能够准确反映新增或修改的业务逻辑,确保文档在业务语义层面的连贯性、一致性与完整性。在此基础上,文档生成模型融合第一代码文本、第二代码文本及历史接口业务逻辑文本,综合上下文、变更细节与既有的历史业务逻辑,生成与源分支代码一致的接口文档。因此,本方案能够有效改善传统方式中文档滞后、人工维护成本高、易出错的问题,能够提升接口文档的时效性、准确性与生成效率。
1.一种接口文档生成方法,其特征在于,所述方法包括:
2.根据权利要求1所述的方法,其特征在于,所述响应于监听到所述合并请求,获取第一代码文本和第二代码文本,包括:
3.根据权利要求1所述的方法,其特征在于,所述通过文档生成模型基于所述第一代码文本、所述第二代码文本和历史接口业务逻辑文本,生成接口文档,包括:
4.根据权利要求3所述的方法,其特征在于,所述将所述第一代码文本、所述第二代码文本和历史接口业务逻辑文本输入至文档生成模型,包括:
5.根据权利要求3所述的方法,其特征在于,所述通过所述文档生成模型基于预设提示词,从所述第二代码文本中获得目标接口标识和所述目标接口标识的接口配置参数,包括:
6.根据权利要求1所述的方法,其特征在于,所述方法还包括:
7.一种接口文档生成装置,其特征在于,所述装置包括:
8.一种电子设备,其特征在于,所述电子设备包括:
9.一种计算机可读存储介质,其特征在于,所述计算机可读存储介质中存储有指令,当所述指令在终端设备上运行时,使得所述终端设备实现如权利要求1-6中任一所述的接口文档生成方法。
10.一种计算机程序产品,其特征在于,当所述计算机程序产品在计算机上运行时,使得所述计算机实现如权利要求1-6中任一所述的接口文档生成方法。
版权声明:本站专利文献数据主要来源于国家知识产权局等公开渠道,由 技术新讯 进行整理汇编。页面设计及数据汇编的著作权归本站所有。全部内容仅供个人学习、科研评估与技术交流参考,严禁用于任何商业用途(包括但不限于直接生产制造、技术转让、倒卖数据等)。
免责条款:专利技术具有时效性,本站不对资料的绝对准确性、完整性和可实施性提供任何明示或暗示的担保。因参考本站内容造成的直接或间接损失,本站不承担相关法律责任。若您认为本站内容有侵权问题,请及时提供权属证明与我们联系,本站将在核实后依法处理。反馈意见:yyfuon@163.com