利索能及
我要发布
收藏
专利号: 2019102997188
申请人: 平安科技(深圳)有限公司
专利类型:发明专利
专利状态:已下证
更新日期:2026-06-16
缴费截止日期: 暂无
联系人

摘要:

权利要求书:

1.一种应用程序编程接口API文档的生成方法,其特征在于,包括:获取应用程序的源代码;所述源代码中包括所述应用程序调用的多个API的接口信息和注释信息;

对所述源代码进行解析,提取出待生成API文档的目标API的接口信息;

从所述源代码中提取出所述目标API的注释信息;

将所述目标API的所述接口信息和所述注释信息进行关联;

根据关联后的所述接口信息和所述注释信息,生成所述目标API的API文档。

2.如权利要求1所述的生成方法,其特征在于,所述对所述源代码进行解析,提取出待生成API文档的目标API的接口信息,包括:对所述源代码进行编译,生成Java字节码;

利用Java类加载器加载所述Java字节码,保留符合预设规则的类;

确定被保留的类的类别,基于反射机制提取各个类别用于描述所述目标API的接口信息。

3.如权利要求2所述的生成方法,其特征在于,所述从所述源代码中提取出所述目标API的注释信息,包括:基于所述源代码,寻找所有类文件并记录每个类文件的文件路径;

对于被保留的类的类文件,根据其文件路径,将源文件加载到JavaDoc提取模块,提取出被保留的每个类的类注释信息,和每个类的每个字段上的文档注释信息。

4.如权利要求2所述的生成方法,其特征在于,所述基于反射机制提取各个类别用于描述所述目标API的接口信息之后,还包括:将各个类别用于描述所述目标API的接口信息按简单Java对象的方式进行存储,形成结构化的接口信息。

5.如权利要求3所述的生成方法,其特征在于,所述提取出被保留的每个类的类注释信息,和每个类的每个字段上的文档注释信息之后,还包括:将所述类注释信息和所述文档注释信息按简单Java对象的方式进行存储,形成结构化的注释信息。

6.如权利要求1至3任一项所述的生成方法,其特征在于,所述接口信息至少包括:接口名称、接口请求参数信息和接口响应参数信息。

7.如权利要求1至3任一项所述的生成方法,其特征在于,所述获取应用程序的源代码,包括:通过Git在预先配置好的应用程序源代码托管地址下载所述应用程序的源代码。

8.一种应用程序编程接口API文档的生成装置,其特征在于,包括:源代码获取模块,用于获取应用程序的源代码;所述源代码中包括所述应用程序调用的多个API的接口信息和注释信息;

第一提取模块,用于对所述源代码进行解析,提取出待生成API文档的目标API的接口信息;

第二提取模块,用于从所述源代码中提取出所述目标API的注释信息;

关联模块,用于将所述目标API的所述接口信息和所述注释信息进行关联;

生成模块,用于根据关联后的所述接口信息和所述注释信息,生成所述目标API的API文档。

9.一种终端设备,包括存储器以及处理器,所述存储器中存储有可在所述处理器上运行的计算机程序,其特征在于,所述处理器执行所述计算机程序时,实现如权利要求1至7任一项所述的生成方法的步骤。

10.一种计算机可读存储介质,所述计算机可读存储介质存储有计算机程序,其特征在于,所述计算机程序被处理器执行时实现如权利要求1至7任一项所述的生成方法的步骤。