接口文档生成方法及相关设备与流程

本申请涉及软件开发，尤其涉及一种接口文档生成方法及相关设备。

背景技术：

1、接口文档是在软件开发过程中服务使用方和服务提供方之间为了提升协作效率而用以进行相互沟通的一种规范化的接口说明文档，是调用接口的依据。通常情况下，源代码中标注有用于描述接口的接口标记，通过现有的编辑器或者打包工具对源代码中的接口标记进行提取解析，生成相应的接口文档。为了便于对多方协同开发过程进行管理，需要对代码文件进行版本控制(revision control)，进而需要实现进行多版本接口文档的生成和管理。然而，现有的编辑器和打包工具不支持对源代码的版本解析，无法适应软件开发过程中的版本控制需求。

技术实现思路

1、本申请实施例的目的提供一种接口文档生成方法及相关设备，用于满足软件开发过程中的多版本控制需求，实现多版本接口文档的生成和展示。

2、为了实现上述目的，本申请实施例采用下述技术方案：

3、第一方面，本申请实施例提供一种接口文档生成方法，包括：

4、确定待解析的代码文件和所述代码文件的版本控制信息；

5、通过文档插件组件根据解析指令，对所述代码文件中的接口标记进行解析，得到文档对象，所述文档对象用于描述所述接口标记所标记的接口；

6、基于所述版本控制信息，将所述文档对象添加至文档管理文件的目标分支下，所述文档管理服务包括多个分支，每个分支对应一个版本的代码文件；

7、基于所述目标分支下的所述文档对象，生成所述代码文件的接口文档。

8、第二方面，本申请实施例提供一种接口文档生成装置，包括：

9、文档插件组件，用于确定待解析的代码文件以及所述代码文件的版本控制信息，以及根据解析指令对所述代码文件中的接口标记进行解析，得到符合接口文档规范的文档对象，所述文档对象用于描述所述接口标记所标记的接口；

10、文档管理服务模块，用于从所述文档插件组件获取所述版本控制信息和所述文档对象，基于所述版本控制信息将所述文档对象添加至文档管理文件的目标分支下，以及基于所述目标分支下的所述文档对象，生成所述代码文件的接口文档，所述文档管理文件包括多个分支，每个分支对应一个版本的代码文件。

11、第三方面，本申请实施例提供一种电子设备，包括：处理器；用于存储所述处理器可执行指令的存储器；其中，所述处理器被配置为执行所述指令，以实现如第一方面所述的接口文档生成方法。

12、第四方面，本申请实施例提供一种计算机可读存储介质，当所述存储介质中的指令由电子设备的处理器执行时，使得电子设备能够执行如第一方面所述的接口文档生成方法。

13、本申请实施例采用的上述至少一个技术方案能够达到以下有益效果：预先开发可配置的文档插件组件，由服务提供方根据待解析的代码文件对文档插件组件进行配置；通过确定待解析的代码文件和代码文件的版本控制信息，并通过文档插件组件根据解析指令，对代码文件中的接口标记进行解析，生成接口文档中的文档对象，该文档对象可用于描述接口标记所标记的接口，为后续生成接口文档提供数据支撑；进一步，在服务使用方侧的文档管理文件下设置多个分支，每个分支对应一个版本的代码文件，基于版本控制信息，将文档对象添加至文档管理文件的目标分支下，使得不同版本的代码文件在文档管理文件中都具有关联的分支，各版本的代码文件中的接口标记被提取解析为关联分支下的文档对象，进而能够支持多版本接口文档的生成和管理；最后，基于目标分支下的文档对象，生成代码文件的接口文档，满足软件开发过程中的各种版本控制需求，实现各种版本接口文档的生成和展示。

技术特征：

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

2.根据权利要求1所述的方法，其特征在于，所述文档插件组件包括扫描器、解析器和多种适配器，每种适配器对应的软件开发规范不同；

3.根据权利要求2所述的方法，其特征在于，所述文档插件组件还包括调度器，所述扫描器和所述解析器的数量均为多个，每个扫描器用于扫描一种类型的接口标记，每个解析器用于解析一种类型的接口标记；

4.根据权利要求1所述的方法，其特征在于，所述基于所述版本控制信息，将所述文档对象添加至文档管理文件的目标分支下，包括：

5.根据权利要求4所述的方法，其特征在于，所述基于所述版本控制信息和所述解析指令的指令类型，确定所述文档管理文件中与所述代码文件关联的目标分支，包括：

6.根据权利要求4所述的方法，其特征在于，所述基于所述版本控制信息和所述解析指令的指令类型，确定所述文档管理文件中与所述代码文件关联的目标分支，包括：

7.根据权利要求1所述的方法，其特征在于，在基于所述版本控制信息，将所述文档对象添加至文档管理文件的目标分支下之前，所述方法还包括：

8.根据权利要求7所述的方法，其特征在于，所述文档质量配置信息包括文档要素与质量评估策略之间的对应关系；

9.一种电子设备，其特征在于，包括：

10.一种计算机可读存储介质，其特征在于，当所述存储介质中的指令由电子设备的处理器执行时，使得电子设备能够执行如权利要求1至8中任一项所述的接口文档生成方法。

技术总结
本申请公开了一种接口文档生成方法及相关设备，用于满足软件开发过程中的多版本控制需求，实现多版本接口文档的生成和展示。所述接口文档生成方法包括：确定待解析的代码文件和所述代码文件的版本控制信息；通过文档插件组件根据解析指令对所述代码文件中的接口标记进行解析，得到符合接口文档规范的文档对象，所述文档对象用于描述所述接口标记所标记的接口；基于所述版本控制信息，将所述文档对象添加至文档管理服务文件的目标分支下；基于所述目标分支下的所述文档对象，生成所述代码文件的接口文档。

技术研发人员：汪南
受保护的技术使用者：马上消费金融股份有限公司
技术研发日：
技术公布日：2024/5/6