[发明专利]接口文档生成方法、装置、计算机设备和存储介质

权利要求书

1.一种接口文档生成方法，其特征在于，所述方法包括：

接收客户端发送的接口文档生成请求；

响应所述接口文档生成请求，获取所述客户端输入的目标项目的项目源代码，并将所述项目源代码转换为源码树；

对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数，根据所述接口参数生成所述目标项目的结构化的接口文档；

将所述接口文档返回至所述客户端。

2.根据权利要求1所述的接口文档生成方法，其特征在于，所述对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档的步骤，包括：

确定所述项目源代码的各个功能模块；

解析所述功能模块对应在源码树上的各个节点，得到所述功能模块的各个接口以及所述接口的接口协议和接口参数；

根据所述接口协议解析所述接口参数，确定所述接口参数的数据类型；

根据所述数据类型将所述接口参数生成结构化的接口文档。

3.根据权利要求2所述的接口文档生成方法，其特征在于，所述解析所述功能模块对应在源码树上的各个节点，得到所述功能模块的各个接口以及所述接口的接口协议和接口参数的步骤，包括：

获取所述节点包含的接口标签；

根据所述接口标签确定所述节点中的接口类；

解析所述接口类，对所述接口类进行方法分析得到所述接口类中的方法集；

获取所述方法集中的接口，并提取所述接口所对应的接口协议和接口参数。

4.根据权利要求2所述的接口文档生成方法，其特征在于，所述根据所述接口协议解析所述接口参数，确定所述接口参数的数据类型的步骤包括：

根据所述接口协议解析所述接口参数的第一属性信息；

根据所述第一属性信息判定所述接口参数的数据类型为基本数据类型或非基本数据类型。

5.根据权利要求4所述的接口文档的生成方法，其特征在于，若所述第一属性信息为基本数据类型；

所述根据所述数据类型将所述接口参数生成结构化的接口文档的步骤，包括：

解析所述接口参数得到第一数据信息；其中，所述第一数据信息包括名称、别名、数据类型、注释以及默认值中的至少一种；

将所述第一数据信息生成结构化的接口文档。

6.根据权利要求5所述的接口文档生成方法，其特征在于，若所述第一属性信息为非基本数据类型；

所述根据所述数据类型将所述接口参数生成结构化的接口文档的步骤，包括：

解析所述接口参数的封装类型；

若所述封装类型为非闭环封装类型，解析所述接口参数的属性列表中的第二属性信息；

若所述第二属性信息为基本数据类型，解析所述接口参数得到第二数据信息；其中，所述第二数据信息包括名称、别名、数据类型、注释以及默认值中的至少一种；

将所述第二数据信息生成结构化的接口文档。

7.根据权利要求1所述的接口文档生成方法，其特征在于，所述根据所述接口参数生成所述目标项目的结构化的接口文档的步骤之后，还包括：

为所述目标项目添加项目标识，对各功能模块添加功能模块标识；

获取所述功能模块的分支标识，并生成所述功能模块的各个接口的统一资源标识符；

将所述项目标识、功能模块标识、分支标识以及统一资源标识符进行关联，生成所述目标项目中接口所对应的接口标识，将所述接口标识作为所述接口文档的唯一标识。

8.根据权利要求1所述的接口文档生成方法，其特征在于，所述将所述接口文档返回至所述客户端的步骤，包括：

将所述接口文档生成HTML格式的接口文档页面，将所述接口文档页面返回至所述客户端。