一种接口文档的自动生成方法及终端设备技术

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

【技术实现步骤摘要】
一种接口文档的自动生成方法及终端设备
本专利技术涉及计算机
，尤其涉及一种接口文档的自动生成方法及终端设备。
技术介绍
在项目开发过程中，通常是前端、后端分别开发，这就需要有一份接口文档，使前后端的开发人员均按照这份接口文档进行开发，并且到项目结束前需要对这份接口文档随时进行更新，以便于开发人员查看、了解最新的接口定义。现有的接口文档大多是由人工手动编写的，包括每个字段的名称、类型、描述等，都需要人工手动注释。当接口数量较多时，这种人工手动编写接口文档的方法效率非常低。
技术实现思路
有鉴于此，本专利技术实施例提供了一种接口文档的自动生成方法及终端设备，以解决现有技术中人工手动编写接口文档的效率低的问题。本专利技术实施例的第一方面，提供了一种接口文档的自动生成方法，可以包括：在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；根据所述目标代码，生成所述目标代码对应的第一抽象语法树；根据所述第一抽象语法树，生成所述目标代码的接口文档。本专利技术实施例的第二方面，提供了一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，所述计算机程序被处理器执行时实现如下步骤：在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；根据所述目标代码，生成所述目标代码对应的第一抽象语法树；根据所述第一抽象语法树，生成所述目标代码的接口文档。本专利技术实施例的第三方面，提供了一种终端设备，包括存储器、处理器以及存储在所述存储器中并可在所述处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现如下步骤：在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；根据所述目标代码，生成所述目标代码对应的第一抽象语法树；根据所述第一抽象语法树，生成所述目标代码的接口文档。本专利技术实施例与现有技术相比存在的有益效果是：本专利技术实施例通过在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；根据所述目标代码，生成所述目标代码对应的第一抽象语法树；根据所述第一抽象语法树，生成所述目标代码的接口文档。通过上述方法，能够将目标代码自动生成接口文档，与人工手动编写接口文档相比，大大提高了接口文档的编写效率。附图说明为了更清楚地说明本专利技术实施例中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本专利技术的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。图1是本专利技术实施例提供的接口文档的自动生成方法的实现流程示意图；图2是本专利技术另一实施例提供的接口文档的自动生成方法的实现流程示意图；图3是本专利技术实施例提供的接口文档的自动生成装置的示意图；图4是本专利技术实施例提供的终端设备的示意图。具体实施方式以下描述中，为了说明而不是为了限定，提出了诸如特定系统结构、技术之类的具体细节，以便透彻理解本专利技术实施例。然而，本领域的技术人员应当清楚，在没有这些具体细节的其它实施例中也可以实现本专利技术。在其它情况中，省略对众所周知的系统、装置、电路以及方法的详细说明，以免不必要的细节妨碍本专利技术的描述。应当理解，当在本说明书和所附权利要求书中使用时，术语“包括”指示所描述特征、整体、步骤、操作、元素和/或组件的存在，但并不排除一个或多个其它特征、整体、步骤、操作、元素、组件和/或其集合的存在或添加。还应当理解，在此本专利技术说明书中所使用的术语仅仅是出于描述特定实施例的目的而并不意在限制本专利技术。如在本专利技术说明书和所附权利要求书中所使用的那样，除非上下文清楚地指明其它情况，否则单数形式的“一”、“一个”及“该”意在包括复数形式。还应当进一步理解，在本专利技术说明书和所附权利要求书中使用的术语“和/或”是指相关联列出的项中的一个或多个的任何组合以及所有可能组合，并且包括这些组合。如在本说明书和所附权利要求书中所使用的那样，术语“如果”可以依据上下文被解释为“当...时”或“一旦”或“响应于确定”或“响应于检测到”。类似地，短语“如果确定”或“如果检测到[所描述条件或事件]”可以依据上下文被解释为意指“一旦确定”或“响应于确定”或“一旦检测到[所描述条件或事件]”或“响应于检测到[所描述条件或事件]”。为了说明本专利技术所述的技术方案，下面通过具体实施例来进行说明。图1是本专利技术实施例提供的一种接口文档的自动生成方法的实现流程示意图，如图所示，所述方法可以包括以下步骤：步骤S101，在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档。在实际应用中，接口文档生成指令的形式可以是人为预先设定的，例如，接口文档生成指令可以包括指令标识符、目标代码的编号等。当接收到接口文档生成指令后，通过指令标识符即可判断出该指令为接口文档生成指令；通过目标代码的编号即可获取该指令对应的目标代码，然后将目标代码生成接口文档。可选的，在获取所述接口文档生成指令对应的目标代码之后，还包括：步骤S11，将所述目标代码的格式转换为预设格式。其中，预设格式是人为预先设定，是指可以生成抽象语法树的格式。抽象语法树为一种程序的中间表示形式。目标代码的格式可以是多种多样的，例如，目标代码可以是按照C语言格式编写的、可以是按照JAVA语言格式编写的等等。将目标代码生成抽象语法树之前，需要先将目标语言进行格式化，即将目标语言的格式转换为统一的格式(预设格式)，这样，不管是哪种格式的目标语言，经过格式化之后，都可以转换为统一的预设格式。之后，再将预设格式的代码生成抽象语法树。步骤S12，对所述预设格式的目标代码进行词法解析。词法解析，是将目标代码切成多个语元，并为每个语元分配一个编号。其中，语元是语言的基本元素，例如，在中文中语元表现为一个独立的字、词；在英文中语元表现为一个单词。对预设格式的目标代码进行词法解析，实际上是将预设格式的目标代码切割成一个一个的语元，并按照顺序为每个语元分配一个编号。示例性的，预设格式的目标代码为ifAplusBisC，对该目标代码进行词法解析之后得到的if、A、plus、B、is、C共6个语元，并为每个语元进行编号，则1.if，2.A，3.plus，4.B，5.is，6.C。需要说明的是，上述只是词法解析的一个示例，并不做具体限定。步骤S13，对进行词法解析后的目标代码进行语法解析，得到预处理代码。语法解析，是在词法解析的基础上将各个语元组合成具有一定语法的语句，如“程序”、“表达式”等。例如，在中文中，词法解析是将一段文字分割成独立的字、词，而语法解析是根据中文语法特征，将分割出的字、词组合成完整的语句。示例性的，假设目标代码为ifAplusBisCelseD。词法解析之后可以分割出8个语元，分别为if、A、plus、B、is、C、else、D，根据程序语言的语法特征可知，if为条件语句，其后边为一个判断条件，else为条件语句，后边为另一个判断条件，根据此特征，可以将本文档来自技高网...

【技术保护点】
1.一种接口文档的自动生成方法，其特征在于，包括：在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；根据所述目标代码，生成所述目标代码对应的第一抽象语法树；根据所述第一抽象语法树，生成所述目标代码的接口文档。

【技术特征摘要】
1.一种接口文档的自动生成方法，其特征在于，包括：在接收到接口文档生成指令后，获取所述接口文档生成指令对应的目标代码，所述接口文档生成指令用于生成所述目标代码的接口文档；根据所述目标代码，生成所述目标代码对应的第一抽象语法树；根据所述第一抽象语法树，生成所述目标代码的接口文档。2.如权利要求1所述的接口文档的自动生成方法，其特征在于，在获取所述接口文档生成指令对应的目标代码之后，还包括：将所述目标代码的格式转换为预设格式；对所述预设格式的目标代码进行词法解析；对进行词法解析后的目标代码进行语法解析，得到预处理代码；所述根据所述目标代码，生成所述目标代码对应的第一抽象语法树，包括：根据所述预处理代码，生成所述目标代码对应的第一抽象语法树。3.如权利要求2所述的接口文档的自动生成方法，其特征在于，所述根据所述第一抽象语法树，生成所述目标代码的接口文档，包括：从所述第一抽象语法树中提取所有接口函数的语法特征值；分别将所述语法特征值转换成接口信息，并将所述接口信息转换成接口文本信息；将所述接口文本信息进行汇总，生成接口文档。4.如权利要求1所述的接口文档的自动生成方法，其特征在于，在生成所述目标代码的接口文档之后，还包括：将所述目标代码进行备份得到备份代码，并启动计时器；当所述计时器的时间等于预设时间时，重新获取所述目标代码，并将所述目标代码记为更新代码；将所述更新代码与所述备份代码进行比对，若所述更新代码与所述备份代码不同，则生成所述更新代码对应的第二抽象语法树；将所述第一抽象语法树与所述第二抽象语法树进行比对；若存在属于所述第一抽象语法树且不属于所述第二抽象语法树的接口函数，则将该接口函数标记为删减的接口函数，并根据所述删减的接口函数更新所述接口文档；若存在属于所述第二抽象语法树且不属于所述第一抽象语法树的接口函数，则将该接口函数标记为新增的接口函数，并根据所述新增的接口函数更新所述接口文档。5.如权利要求4所述的接口文档的自动生成方法，其特征在于，所述根据所述删减的接口函数更新所述接口文档，包括：从...

【专利技术属性】
技术研发人员：闫国虹，
申请(专利权)人：深圳壹账通智能科技有限公司，
类型：发明
国别省市：广东,44