一种接口文档生成方法及装置与流程

摘要: 本申请实施例涉及计算机,尤其涉及一种接口文档生成方法及装置。背景技术:1、接口文档是描述系统交互规则的标准化文档,相当于技术说明书,其在技术人员使用系统时起到指...
一种接口文档生成方法及装置与流程

本申请实施例涉及计算机,尤其涉及一种接口文档生成方法及装置。

背景技术:

1、接口文档是描述系统交互规则的标准化文档,相当于技术说明书 ,其在技术人员使用系统时起到指引作用。

2、目前,一般是由开发人员对项目代码进行阅读后手动进行接口文档的编写。这种编写方式虽然准确,但是非常耗时。

技术实现思路

1、本申请提供一种接口文档生成方法及装置,用以高效、准确地生成接口文档。

2、第一方面,本申请实施例提供一种接口文档生成方法,包括:获取第一代码的源码文件、字节码文件以及映射配置文件,所述映射配置文件表征接口与数据库查询语句之间的映射关系;从所述源码文件获取在接口入口层级的第一信息、从所述字节码文件获取在函数调用层级的第二信息和从所述映射配置文件获取在数据查询层级的第三信息;按照接口文档生成规范对所述第一信息、所述第二信息和所述第三信息进行组织,生成所述第一代码的第一接口上下文;将所述第一接口上下文输入大语言模型,通过所述大语言模型输出符合所述接口文档生成规范的第一接口文档。

3、上述方案中,描述了对于第一代码该如何准确又高效的生成其对应的接口文档的过程,在该过程中由于首先获取第一代码的源码文件、字节码文件和映射配置文件,这些文件已然含有了技术实现的全部内容,但由于文件的可读性差,所以可继续从三个文件中依次获取在接口入口层级的第一信息、在函数调用层级的第二信息和在数据查询层级的第三信息,接着通过对三方面信息进行组织,可生成第一代码的第一接口上下文,最后通过将该第一接口上下文输入大语言模型,便可以通过大语言模型输出符合接口文档生成规范的第一接口文档。由于该过程首先提取出关于技术实现的三方面信息,如此可以保证接口文档生成的准确性,二来通过使用大语言模型生成接口文档,而避免人工的方式,从而可以提升接口文档生成的效率。

4、在一种可能实现的方法中,所述从所述源码文件获取在接口入口层级的第一信息,包括:通过抽象语法树对所述源码文件进行解析;基于解析后的源码文件中的注解,识别各接口入口方法;针对任一接口入口方法,获取所述接口入口方法的属性信息;其中,所述属性信息至少包括接口名称、请求路径、请求方式、入参信息、出参信息一项或多项。

5、在一种可能实现的方法中,所述获取所述接口入口方法的属性信息,包括:通过解析后的源码文件,获取所述接口入口方法的接口名称、请求路径和请求方式;通过解析后的源码文件和所述字节码文件,获取所述接口入口方法的入参信息和出参信息;在所述入参信息和/或所述出参信息以泛型或者嵌套格式表达时,则通过递归的方式获取到最里层的入参信息和/或出参信息。

6、在一种可能实现的方法中,所述从所述字节码文件获取在函数调用层级的第二信息,包括:以任一接口入口方法作为根节点,从所述字节码文件中读取所述接口入口方法对应的调用指令,得到所述接口入口方法涉及的调用链信息。

7、在一种可能实现的方法中,若调用指令为lambda表达式或方法引用,则恢复所述lambda表达式或所述方法引用实际指向的目标方法,并将所述目标方法纳入调用链信息。

8、在一种可能实现的方法中,所述从所述映射配置文件获取在数据查询层级的第三信息,包括:在任一调用链涉及数据访问层时,基于所述调用链中的访问方法从所述映射配置文件中获取结构化查询sql语句。

9、在一种可能实现的方法中,所述生成所述第一代码的第一接口上下文之前,还包括:记录所述第一信息、所述第二信息和所述第三信息在所述第一代码中对应的代码位置为来源信息;所述通过所述大语言模型输出符合所述接口文档生成规范的第一接口文档之后,还包括:按照所述来源信息对所述第一接口文档进行一致性校验。

10、在一种可能实现的方法中,获取第二代码;其中,所述第二代码是所述第一代码的迭代版本;确定所述第二代码与所述第一代码之间的变更代码;根据所述变更代码确定受影响接口;根据所述受影响接口对所述第一接口文档进行更新,从而得到所述第二代码的第二接口文档;基于所述第一代码到所述第二代码的版本变更关系,保存所述第二接口文档对所述第一接口文档的继承关系。

11、在一种可能实现的方法中,所述通过所述大语言模型输出符合所述接口文档生成规范的第一接口文档之后,还包括:记录所述第一接口文档的依赖快照;其中,所述第一接口文档的依赖快照包括所述第一接口上下文;所述根据所述变更代码确定受影响接口,包括:根据所述变更代码确定变更集合,所述变更集合包括变更方法、变更数据对象和变更sql中的至少一项;所述变更方法包括变化的业务组件类,所述变更数据对象包括变化的数据对象类,所述变更sql通过变化的映射配置文件得到;根据所述变更集合查询历史依赖快照,确定受影响接口。

12、第二方面,本申请实施例提供一种接口文档生成装置,包括:文件获取单元,用于获取第一代码的源码文件、字节码文件以及映射配置文件,所述映射配置文件表征接口与数据库查询语句之间的映射关系;信息获取单元,用于从所述源码文件获取在接口入口层级的第一信息、从所述字节码文件获取在函数调用层级的第二信息和从所述映射配置文件获取在数据查询层级的第三信息;接口上下文生成单元,用于按照接口文档生成规范对所述第一信息、所述第二信息和所述第三信息进行组织,生成所述第一代码的第一接口上下文;接口文档生成单元,用于将所述第一接口上下文输入大语言模型,通过所述大语言模型输出符合所述接口文档生成规范的第一接口文档。

13、第三方面,本申请实施例提供了一种计算设备,包括:

14、存储器,用于存储程序指令;

15、处理器,用于调用所述存储器中存储的程序指令,按照获得的程序执行如第一方面任一实现方法。

16、第四方面,本申请实施例提供了一种计算机可读存储介质,所述计算机可读存储介质存储有计算机可执行指令,所述计算机可执行指令用于使计算机执行如第一方面任一实现方法。

17、第五方面,本申请实施例提供了一种计算机程序产品,所述计算机程序产品包括计算机可执行指令,所述计算机可执行指令用于使计算机执行如第一方面任一实现方法。

1.一种接口文档生成方法,其特征在于,包括:

2.如权利要求1所述的方法,其特征在于,

3.如权利要求2所述的方法,其特征在于,

4.如权利要求1所述的方法,其特征在于,

5.如权利要求4所述的方法,其特征在于,若调用指令为lambda表达式或方法引用,则恢复所述lambda表达式或所述方法引用实际指向的目标方法,并将所述目标方法纳入调用链信息。

6.如权利要求1所述的方法,其特征在于,

7.如权利要求1至6任一项所述的方法,其特征在于,

8.如权利要求1-6任一项所述的方法,其特征在于,所述方法还包括:

9.如权利要求8所述的方法,其特征在于,

10.一种计算设备,其特征在于,包括: