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

说明书

本发明涉及一种接口文档生成方法、装置、计算机设备和存储介质。该方法通过接收并响应客户端发送的接口文档生成请求，获取客户端输入的目标项目的项目源代码，将项目源代码转换为源码树，解析源码树的各个节点，以获取各个功能模块包含的接口及其接口参数，并生成该目标项目的结构化接口文档，将接口文档返回至客户端，实现了接口文档的动态生成，提高了生成接口文档的效率和接口文档内容信息的准确率，提高了软件开发的效率。

技术领域

本发明涉及软件开发技术领域，特别是涉及一种接口文档生成方法、装置、计算机设备和存储介质。

背景技术

在软件项目开发过程中，企业一般采用前后端分离的开发模式进行开发，即前端和后端开发人员对项目需求分解后并行进行开发，这种开发模式有利于大型软件系统的协作，从而提高开发速度。然而，这种开发模式需要前端开发人员、后端开发人员和测试人员之间的紧密沟通，如前端开发依赖于后端的接口数据，后端开发人员需要提供完善的接口文档给前端开发人员，以便于前端开发人员直接修改项目接口前缀，切换到对应的环境，进入项目提测。

现有技术中生成接口文档的方式为：在应用的开发过程中，将编写所涉及到的接口，在文档中写入该接口的各种属性、参数等接口说明，形成接口文档。当某一个接口所涉及的属性信息以及属性信息对应的属性参数进行修改时，则需要在接口文档中查找该对应的接口说明，并进行对应的修改。

然而，发明人在实践过程中发现现有技术至少存在以下问题：在接口开发过程中，接口文档的编写增加了开发时间，降低了测试效率，而且在接口更新或修改时，如果没有及时更新，导致后续的测试容易出错。

发明内容

本发明的目的旨在至少能解决上述的技术缺陷之一，特别是接口文档的编写增加了开发时间，降低了测试效率的技术问题。

第一方面，本发明实施例提供一种接口文档生成方法，所述方法包括：

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

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

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

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

在其中一个实施例中，所述对所述源码树的各个节点进行解析，获取项目源代码各个功能模块包含的接口及其接口参数,根据所述接口参数生成所述目标项目的结构化的接口文档的步骤，包括：

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

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

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

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

在其中一个实施例中，所述解析所述功能模块对应在源码树上的各个节点，得到所述功能模块的各个接口以及所述接口的接口协议和接口参数的步骤，包括：

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

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

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

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

在其中一个实施例中，所述根据所述接口协议解析所述接口参数，确定所述接口参数的数据类型的步骤包括：