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

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

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


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

技术介绍

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

技术实现思路

[0004]本公开的目的在于提供一种接口文档生成方法及系统、计算机可读存储介质及电子设备，至少在一定程度上提升接口文档生成效率。
[0005]本公开的其他特性和优点将通过下面的详细描述变得显然，或部分地通过本公开的实践而习得。
[0006]根据本公开的第一个方面，提供一种接口文档生成方法，上述方法包括：获取控制器文件夹中的多个文件，并对上述多个文件进行递归，得到文件树；将上述多个文件分别进行转换，得到本文档来自技高网...

【技术保护点】

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

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