接口文档生成方法及系统、存储介质及电子设备技术方案

本发明专利技术提供了一种接口文档生成方法及系统、存储介质及电子设备，涉及计算机技术领域。其中，该方法包括：获取控制器文件夹中的多个文件，并对多个文件进行递归，得到文件树；将多个文件分别进行转换，得到每个文件对应的第一字符流，并将第一字符流解析为抽象语法树，其中，抽象语法树中包括每个文件中的多个函数节点；遍历抽象语法树，将多个函数节点分别进行转换，得到每个函数节点对应的第二字符流；将第二字符流转换为对应的接口文档，并将接口文档挂载至文件树中。本技术方案通过编译原理、抽象语法树以及文档生成工具来实现接口文档生成，能够消除接口文档生成时的错误率，提高开发效率。开发效率。开发效率。

【技术实现步骤摘要】
接口文档生成方法及系统、存储介质及电子设备


[0001]本公开涉及计算机
，尤其涉及一种接口文档生成方法及系统、计算机可读存储介质及电子设备。

技术介绍

[0002]在项目开发场景下，前端与后端的开发人员之间需要通过接口文档来进行交流，并且接口文档可以方便开发人员对项目的查看与维护。因此，便捷、高效地生成规范的接口文档对项目开发具有重要意义。
[0003]需要说明的是，在上述
技术介绍
部分公开的信息仅用于加强对本公开的背景的理解，因此可以包括不构成对本领域普通技术人员已知的现有技术的信息。

技术实现思路

[0004]本公开的目的在于提供一种接口文档生成方法及系统、计算机可读存储介质及电子设备，至少在一定程度上提升接口文档生成效率。
[0005]本公开的其他特性和优点将通过下面的详细描述变得显然，或部分地通过本公开的实践而习得。
[0006]根据本公开的第一个方面，提供一种接口文档生成方法，上述方法包括：获取控制器文件夹中的多个文件，并对上述多个文件进行递归，得到文件树；将上述多个文件分别进行转换，得到每个文件对应的第一字符流，并将上述第一字符流解析为抽象语法树，其中，上述抽象语法树中包括上述每个文件中的多个函数节点；遍历上述抽象语法树，将上述多个函数节点分别进行转换，得到每个函数节点对应的第二字符流；将上述第二字符流转换为对应的接口文档，并将上述接口文档挂载至上述文件树中。
[0007]在本公开一个实施例中，上述获取控制器文件夹中的多个文件之前，上述方法还包括：创建子进程；上述对上述多个文件进行递归，得到文件树，包括：通过上述子进程，判断上述控制器文件夹中是否包括文件；若上述控制器文件夹中包括文件，则将上述文件对应的对象节点挂载至上述文件树中，其中，上述对象节点的名称与文件名称相同；若上述控制器文件夹中不包括文件，则在上述文件树中挂载空的对象节点。
[0008]在本公开一个实施例中，上述创建子进程之后，上述方法包括：通过上述子进程监听上述控制器文件夹中的多个文件，以在预设时间内监听上述文件中应用程序代码的变化；在上述应用程序代码产生变化的情况下，则获取上述控制器文件夹中的多个文件，并对上述多个文件进行递归，以重新生成上述文件树。
[0009]在本公开一个实施例中，上述创建子进程之后，上述方法还包括：通过上述子进程监听应用程序，以在上述预设时间内监听上述控制器文件夹对应的哈希值的变化；在上述哈希值产生变化的情况下，则获取上述控制器文件夹中的多个文件，并对上述多个文件进行递归，以重新生成上述文件树。
[0010]在本公开一个实施例中，上述创建子进程之后，上述方法还包括：在上述子进程中
创建文档展示服务，通过上述文档展示服务，对上述文档树进行展示；通过点击上述对象节点展示上述接口文档。
[0011]在本公开一个实施例中，上述将上述第二字符流转换为对应的接口文档，包括：创建第一文件，其中，上述第一文件的文件名称为根据上述每个函数节点的名称和上述每个函数节点所在文件的文件名称确定的；将上述第二字符流写入上述第一文件；通过文档生成器，将上述第一文件转换为上述接口文档。
[0012]在本公开一个实施例中，上述接口文档中包括上述每个函数节点的名称；上述将上述接口文档挂载至上述文件树中，包括：根据上述接口文档中的上述每个函数节点的名称，得到上述第一文件中上述每个函数节点所在文件的文件名称；遍历上述文件树，根据上述每个函数节点所在文件的文件名称，将上述接口文档挂载至文件树中对应的对象节点的子节点中。
[0013]根据本公开的第二个方面，提供一种接口文档生成系统，上述系统包括：递归模块，用于：获取控制器文件夹中的多个文件，并对上述多个文件进行递归，得到文件树；第一转换模块，用于：将上述多个文件分别进行转换，得到每个文件对应的第一字符流，并将上述第一字符流解析为抽象语法树，其中，上述抽象语法树中包括上述每个文件中的多个函数节点；第二转换模块，用于：遍历上述抽象语法树，将上述多个函数节点分别进行转换，得到每个函数节点对应的第二字符流；挂载模块，用于：将上述第二字符流转换为对应的接口文档，并将上述接口文档挂载至上述文件树中。
[0014]根据本公开的第三个方面，提供一种电子设备，包括：存储器、处理器以及存储在上述存储器中并可在上述处理器上运行的计算机程序，上述处理器执行上述计算机程序时实现所述第一个方面或第二个方面的接口文档生成方法。
[0015]根据本公开的第四个方面，提供一种计算机可读存储介质，其上存储有计算机程序，上述计算机程序被处理器执行时实现所述第一个方面或第二个方面的接口文档生成方法。
[0016]本公开的实施例所提供的接口文档生成方法及系统、计算机可读存储介质及电子设备，具备以下技术效果：
[0017]在本公开实施例提供的接口文档生成过程中，获取控制器文件夹中的多个文件，并对多个文件进行递归，得到文件树；将多个文件分别进行转换，得到每个文件对应的第一字符流，并将第一字符流解析为抽象语法树，其中，抽象语法树中包括每个文件中的多个函数节点；遍历抽象语法树，将多个函数节点分别进行转换，得到每个函数节点对应的第二字符流；将第二字符流转换为对应的接口文档，并将接口文档挂载至文件树中。本技术方案通过上述文件树以及抽象语法树，建立了树状文档结构，可以用于打开对应的接口文件以及文件中包含的接口，能够降低接口文档生成时的错误率，从而提高接口文档生成效率。
[0018]应当理解的是，以上的一般描述和后文的细节描述仅是示例性和解释性的，并不能限制本公开。
附图说明
[0019]此处的附图被并入说明书中并构成本说明书的一部分，示出了符合本公开的实施例，并与说明书一起用于解释本公开的原理。显而易见地，下面描述中的附图仅仅是本公开
的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。
[0020]图1示意性示出了本公开一实施例提供的一种接口文档生成方法的流程图；
[0021]图2示意性示出了本公开另一实施例提供的字符流转换为文档的流程图；
[0022]图3示意性示出了本公开再一实施例提供的字符流转换为文档的流程图；
[0023]图4示出了树形文档结构的示意图；
[0024]图5示意性示出了本公开一实施例提供的接口文档生成系统的结构图；
[0025]图6示意性示出了本公开一实施例提供的一种电子设备的框图。
具体实施方式
[0026]为使本公开的目的、技术方案和优点更加清楚，下面将结合附图对本公开实施例方式作进一步地详细描述。
[0027]下面的描述涉及附图时，除非另有表示，不同附图中的相同数字表示相同或相似的要素。以下示例性实施例中所描述的实施方式并不代表与本公开相一致的所有实施方式。相反，它们仅是如所附权利要求书中所详述的、本公开的一些方面相一致的装置和方法的例子。
[0028]在本公开的描本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档生成方法，其特征在于，包括：获取控制器文件夹中的多个文件，并对所述多个文件进行递归，得到文件树；将所述多个文件分别进行转换，得到每个文件对应的第一字符流，并将所述第一字符流解析为抽象语法树，其中，所述抽象语法树中包括所述每个文件中的多个函数节点；遍历所述抽象语法树，将所述多个函数节点分别进行转换，得到每个函数节点对应的第二字符流；将所述第二字符流转换为对应的接口文档，并将所述接口文档挂载至所述文件树中。2.根据权利要求1所述的接口文档生成方法，其特征在于，所述获取控制器文件夹中的多个文件之前，所述方法还包括：创建子进程；所述对所述多个文件进行递归，得到文件树，包括：通过所述子进程，判断所述控制器文件夹中是否包括文件；若所述控制器文件夹中包括文件，则将所述文件对应的对象节点挂载至所述文件树中，其中，所述对象节点的名称与文件名称相同；若所述控制器文件夹中不包括文件，则在所述文件树中挂载空的对象节点。3.根据权利要求2所述的接口文档生成方法，其特征在于，所述创建子进程之后，所述方法还包括：通过所述子进程监听所述控制器文件夹中的多个文件，以在预设时间内监听所述文件中应用程序代码的变化；在所述应用程序代码产生变化的情况下，则获取所述控制器文件夹中的多个文件，并对所述多个文件进行递归，以重新生成所述文件树。4.根据权利要求2或3所述的接口文档生成方法，其特征在于，所述创建子进程之后，所述方法还包括：通过所述子进程监听应用程序，以在所述预设时间内监听所述控制器文件夹对应的哈希值的变化；在所述哈希值产生变化的情况下，则获取所述控制器文件夹中的多个文件，并对所述多个文件进行递归，以重新生成所述文件树。5.根据权利要求2至4中任意一项所述的接口文档生成方法，其特征在于，所述创建子进程之后，所述方法还包括：在所述子进程中创建文档展示服务，通过所述文档展示服务，...

【专利技术属性】
技术研发人员：潘宣辰，齐飘洋，陈柱，董超，
申请(专利权)人：武汉安天信息技术有限责任公司，
类型：发明
国别省市：