[发明专利]一种接口文档的自动生成方法及终端设备

说明书

本发明适用于计算机技术领域，提供了一种接口文档的自动生成方法及终端设备，包括：在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；根据所述目标代码，生成所述目标代码对应的第一抽象语法树；根据所述第一抽象语法树，生成所述目标代码的接口文档。通过上述方法，能够将目标代码自动生成接口文档，与人工手动编写接口文档相比，大大提高了接口文档的编写效率。

技术领域

本发明涉及计算机技术领域，尤其涉及一种接口文档的自动生成方法及终端设备。

背景技术

在项目开发过程中，通常是前端、后端分别开发，这就需要有一份接口文档，使前后端的开发人员均按照这份接口文档进行开发，并且到项目结束前需要对这份接口文档随时进行更新，以便于开发人员查看、了解最新的接口定义。

现有的接口文档大多是由人工手动编写的，包括每个字段的名称、类型、描述等，都需要人工手动注释。当接口数量较多时，这种人工手动编写接口文档的方法效率非常低。

发明内容

有鉴于此，本发明实施例提供了一种接口文档的自动生成方法及终端设备，以解决现有技术中人工手动编写接口文档的效率低的问题。

本发明实施例的第一方面，提供了一种接口文档的自动生成方法，可以包括：

在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；

根据所述目标代码，生成所述目标代码对应的第一抽象语法树；

根据所述第一抽象语法树，生成所述目标代码的接口文档。

本发明实施例的第二方面，提供了一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，所述计算机程序被处理器执行时实现如下步骤：

在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；

根据所述目标代码，生成所述目标代码对应的第一抽象语法树；

根据所述第一抽象语法树，生成所述目标代码的接口文档。

本发明实施例的第三方面，提供了一种终端设备，包括存储器、处理器以及存储在所述存储器中并可在所述处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现如下步骤：

在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；

根据所述目标代码，生成所述目标代码对应的第一抽象语法树；

根据所述第一抽象语法树，生成所述目标代码的接口文档。

本发明实施例与现有技术相比存在的有益效果是：

本发明实施例通过在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；根据所述目标代码，生成所述目标代码对应的第一抽象语法树；根据所述第一抽象语法树，生成所述目标代码的接口文档。通过上述方法，能够将目标代码自动生成接口文档，与人工手动编写接口文档相比，大大提高了接口文档的编写效率。

附图说明

为了更清楚地说明本发明实施例中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。

图1是本发明实施例提供的接口文档的自动生成方法的实现流程示意图；