CN111638908A - 接口文档生成方法、装置、电子设备及介质 - Google Patents

Abstract

本发明涉及大数据，提供一种接口文档生成方法，该方法能够当接收到文档生成指令时，从文档生成指令中提取项目名称，根据项目名称，从配置平台上获取与项目名称对应的第一代码文件，遍历第一代码文件，得到第一代码文件的接口信息，根据接口信息，生成与第一代码文件对应的目标文件，监听配置平台上的提交操作，当配置平台上有提交操作产生时，从配置平台上获取与提交操作对应的第二代码文件，基于第一代码文件，对第二代码文件进行代码分析检测，得到差异代码，从差异代码中提取目标字段及目标类型，根据目标字段及目标类型更新目标文件，生成接口文档，提高接口文档的生成效率。本发明还涉及区块链技术，所述接口文档存储于区块链中。

Description

接口文档生成方法、装置、电子设备及介质

技术领域

本发明涉及大数据的数据处理技术领域，尤其涉及一种接口文档生成方法、装置、电子设备及介质。

背景技术

在涉及编程的项目开发过程中，企业一般采用前后端分离的开发模式对项目进行开发，即：将前端和后端的任务进行分解后，前后端的开发人员再根据各自的任务并行开发项目，这种开发模式能够缩短项目的开发周期。然而，由于前端的开发任务依赖于后端的接口数据，因此，在这种开发模式下，需要前端开发人员与后端开发人员的紧密沟通。

通常情况下，需要开发人员编写接口文档进行沟通，然而，由于这种方式需要人工编写文档，文档的生成效率极低。另外，当生成的接口文档需要修改时，仍然需要人工对接口文档的内容进行更改，进而生成接口文档，由于人工对原始接口文档的修改效率低下，使得接口文档的生成效率也低下，进而造成前端开发人员无法及时获知到修改情况，导致无法及时更新前端页面的数据。

因此，如何提高接口文档的生成效率，成了有待解决的技术问题。

发明内容

鉴于以上内容，有必要提供一种接口文档生成方法、装置、电子设备及介质，能够提高接口文档的生成效率。

一种接口文档生成方法，所述方法包括：

当接收到文档生成指令时，从所述文档生成指令中提取项目名称；

从配置平台上获取与所述项目名称对应的第一代码文件；

遍历所述第一代码文件，得到所述第一代码文件的接口信息；

根据所述接口信息，生成与所述第一代码文件对应的目标文件；

监听所述配置平台上的提交操作；

当所述配置平台上有提交操作产生时，从所述配置平台上获取与所述提交操作对应的第二代码文件；

基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码；

从所述差异代码中提取目标字段及目标类型；

根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档。

根据本发明优选实施例，所述遍历所述第一代码文件，得到所述第一代码文件的接口信息包括：

将所述第一代码文件的源码转换成第一抽象语法树，并遍历所述第一抽象语法树中的类及类方法，得到所述类的代码注解；

解析所述类的代码注解，得到第一注解信息；

基于递归遍历方法，遍历所述类对应的父类及所述父类的类方法，得到所述父类的代码注解；

解析所述父类的代码注解，得到第二注解信息；

融合所述第一注解信息及所述第二注解信息，得到与所述第一代码文件对应的目标注解信息；

根据所述目标注解信息及所述源码，生成所述接口信息。

根据本发明优选实施例，在从所述配置平台上获取与所述提交操作对应的第二代码文件之前，所述方法还包括：

确定产生所述提交操作的目标人物；

检测所述目标人物是否存在于配置名单中；

当所述目标人物存在于所述配置名单中，确定所述目标人物具有提交权限；

获取所述提交操作对应的文件名称；

检测所述文件名称是否与所述项目名称一致；

当所述文件名称与所述项目名称一致时，确定所述文件名称对应的项目与所述项目名称对应的项目一致。

根据本发明优选实施例，所述基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码包括：

获取所述第一代码文件的第一源码及所述第二代码文件的第二源码，将所述第一源码与所述第二源码进行全文比对，得到所述差异代码；及/或

获取所述第二代码文件中以修订模式标识的源码，作为所述差异代码。

根据本发明优选实施例，所述从所述差异代码中提取目标字段及目标类型包括：

将所述差异代码的格式转换为预设格式，得到具有预设格式的目标代码；

对所述目标代码进行词法解析；

对词法解析后的目标代码进行语法解析，得到预处理代码；

根据所述预处理代码，生成与所述差异代码对应的第二抽象语法树；

从所述第二抽象语法树中提取所述目标字段及所述目标类型。

根据本发明优选实施例，所述接口文档存储于区块链中，所述根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档包括：

当所述目标类型为增加类型时，将所述目标字段添加至所述目标文件中，生成所述接口文档；及/或

当所述目标类型为删除类型时，将所述目标字段从所述目标文件中删除，生成所述接口文档；及/或

当所述目标类型为更改类型时，采用所述目标字段替换所述目标文件中与所述目标字段对应的数据。

根据本发明优选实施例，在生成所述接口文档后，所述方法还包括：

获取所述第二代码文件的版本号；

根据所述版本号、所述项目名称及所述接口文档生成提示信息；

采用对称加密技术加密所述提示信息，得到密文；

将所述密文发送至指定联系人的终端设备；

当检测到所述密文被成功解密时，在所述终端设备上显示所述接口文档。

一种接口文档生成装置，所述装置包括：

提取单元，用于当接收到文档生成指令时，从所述文档生成指令中提取项目名称；

获取单元，用于从配置平台上获取与所述项目名称对应的第一代码文件；

遍历单元，用于遍历所述第一代码文件，得到所述第一代码文件的接口信息；

生成单元，用于根据所述接口信息，生成与所述第一代码文件对应的目标文件；

监听单元，用于监听所述配置平台上的提交操作；

所述获取单元，还用于当所述配置平台上有提交操作产生时，从所述配置平台上获取与所述提交操作对应的第二代码文件；

检测单元，用于基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码；

所述提取单元，还用于从所述差异代码中提取目标字段及目标类型；

所述生成单元，还用于根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档。

根据本发明优选实施例，所述遍历单元具体单元用于：

将所述第一代码文件的源码转换成第一抽象语法树，并遍历所述第一抽象语法树中的类及类方法，得到所述类的代码注解；

解析所述类的代码注解，得到第一注解信息；

基于递归遍历方法，遍历所述类对应的父类及所述父类的类方法，得到所述父类的代码注解；

解析所述父类的代码注解，得到第二注解信息；

融合所述第一注解信息及所述第二注解信息，得到与所述第一代码文件对应的目标注解信息；

根据所述目标注解信息及所述源码，生成所述接口信息。

根据本发明优选实施例，所述装置还包括：

确定单元，用于在从所述配置平台上获取与所述提交操作对应的第二代码文件之前，确定产生所述提交操作的目标人物；

所述检测单元，还用于检测所述目标人物是否存在于配置名单中；

所述确定单元，还用于当所述目标人物存在于所述配置名单中，确定所述目标人物具有提交权限；

所述获取单元，还用于获取所述提交操作对应的文件名称；

所述检测单元，还用于检测所述文件名称是否与所述项目名称一致；

所述确定单元，还用于当所述文件名称与所述项目名称一致时，确定所述文件名称对应的项目与所述项目名称对应的项目一致。

根据本发明优选实施例，所述检测单元基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码包括：

获取所述第一代码文件的第一源码及所述第二代码文件的第二源码，将所述第一源码与所述第二源码进行全文比对，得到所述差异代码；及/或

获取所述第二代码文件中以修订模式标识的源码，作为所述差异代码。

根据本发明优选实施例，所述提取单元从所述差异代码中提取目标字段及目标类型包括：

将所述差异代码的格式转换为预设格式，得到具有预设格式的目标代码；

对所述目标代码进行词法解析；

对词法解析后的目标代码进行语法解析，得到预处理代码；

根据所述预处理代码，生成与所述差异代码对应的第二抽象语法树；

从所述第二抽象语法树中提取所述目标字段及所述目标类型。

根据本发明优选实施例，所述生成单元根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档包括：

当所述目标类型为增加类型时，将所述目标字段添加至所述目标文件中，生成所述接口文档；及/或

当所述目标类型为删除类型时，将所述目标字段从所述目标文件中删除，生成所述接口文档；及/或

当所述目标类型为更改类型时，采用所述目标字段替换所述目标文件中与所述目标字段对应的数据。

根据本发明优选实施例，所述获取单元，还用于在生成所述接口文档后，获取所述第二代码文件的版本号；

所述生成单元，还用于根据所述版本号、所述项目名称及所述接口文档生成提示信息；

所述装置还包括：

加密单元，用于采用对称加密技术加密所述提示信息，得到密文；

发送单元，用于将所述密文发送至指定联系人的终端设备；

显示单元，用于当检测到所述密文被成功解密时，在所述终端设备上显示所述接口文档。

一种电子设备，所述电子设备包括：

存储器，存储至少一个指令；及

处理器，获取所述存储器中存储的指令以实现所述接口文档生成方法。

一种计算机可读存储介质，所述计算机可读存储介质中存储有至少一个指令，所述至少一个指令被电子设备中的处理器获取以实现所述接口文档生成方法。

由以上技术方案可以看出，本发明通过检测所述配置平台上的提交操作，及对所述第二代码文件进行代码分析检测，能够快速确定被修改的差异代码，进而根据所述差异代码快速修改所述目标文件，进而得到所述接口文档，由于无需重复生成与所述目标文件相同的接口信息，因此，能够提高所述接口文档的生成效率。

附图说明

图1是本发明接口文档生成方法的较佳实施例的流程图。

图2是本发明接口文档生成装置的较佳实施例的功能模块图。

图3是本发明实现接口文档生成方法的较佳实施例的电子设备的结构示意图。

具体实施方式

为了使本发明的目的、技术方案和优点更加清楚，下面结合附图和具体实施例对本发明进行详细描述。

如图1所示，是本发明接口文档生成方法的较佳实施例的流程图。根据不同的需求，该流程图中步骤的顺序可以改变，某些步骤可以省略。

所述接口文档生成方法应用于一个或者多个电子设备中，所述电子设备是一种能够按照事先设定或存储的指令，自动进行数值计算和/或信息处理的设备，其硬件包括但不限于微处理器、专用集成电路(Application Specific Integrated Circuit，ASIC)、可编程门阵列(Field－Programmable Gate Array，FPGA)、数字处理器(Digital SignalProcessor，DSP)、嵌入式设备等。

所述电子设备可以是任何一种可与用户进行人机交互的电子产品，例如，个人计算机、平板电脑、智能手机、个人数字助理(Personal Digital Assistant，PDA)、游戏机、交互式网络电视(Internet Protocol Television，IPTV)、智能式穿戴式设备等。

所述电子设备还可以包括网络设备和/或用户设备。其中，所述网络设备包括，但不限于单个网络服务器、多个网络服务器组成的服务器组或基于云计算(CloudComputing)的由大量主机或网络服务器构成的云。

所述电子设备所处的网络包括但不限于互联网、广域网、城域网、局域网、虚拟专用网络(Virtual Private Network，VPN)等。

S10，当接收到文档生成指令时，从所述文档生成指令中提取项目名称。

在本发明的至少一个实施例中，所述文档生成指令的内容包括，但不限于：目标标签与项目名称的对应关系、指令编号等，另外，所述文档生成指令可以是由监管文档生成的负责人发出的。

在本发明的至少一个实施例中，所述电子设备获取目标标签，进一步地，所述电子设备从所述文档生成指令所携带的所有信息中提取与所述目标标签对应的信息，作为所述项目名称。

其中，所述目标标签对应的信息表征项目名称。

例如：文档生成指令A为“标签1：指令编号200；标签2：客户端A”，所述电子设备确定目标标签为标签2，进一步地，所述电子设备从“标签1：指令编号200；标签2：客户端A”中提取与所述标签2对应的“客户端A”，作为所述项目名称。

S11，从配置平台上获取与所述项目名称对应的第一代码文件。

在本发明的至少一个实施例中，所述配置平台上存储有项目名称与代码文件的对应关系，例如，项目名称B：代码文件。另外，所述配置平台能够把开发团队中每个成员修改的代码做一次备份，每提交或签入一次都会有记录，具有避免重复拷贝，集中管理的特点，所述配置平台可以是版本管理工具，本发明不作限制。

由于所述配置平台上存储有项目名称与代码文件的对应关系，因此，所述电子设备能够根据所述项目名称从所述配置平台上获取所述第一代码文件。

在其他实施例中，当所述项目名称对应的代码文件有多个时，获取所述多个代码文件中每个代码文件的上传时间，及获取当前时间，所述上传时间表征代码文件被上传到所述配置平台上的时间，进一步地，所述电子设备将距离所述当前时间最近的上传时间确定为目标上传时间，并将所述目标上传时间对应的代码文件确定为所述第一代码文件。

S12，遍历所述第一代码文件，得到所述第一代码文件的接口信息。

在本发明的至少一个实施例中，所述遍历所述第一代码文件，得到所述第一代码文件的接口信息包括：

所述电子设备将所述第一代码文件的源码转换成第一抽象语法树，并遍历所述第一抽象语法树中的类及类方法，得到所述类的代码注解，所述电子设备解析所述类的代码注解，得到第一注解信息，基于递归遍历方法，所述电子设备遍历所述类对应的父类及所述父类的类方法，得到所述父类的代码注解，进一步地，所述电子设备解析所述父类的代码注解，得到第二注解信息，所述电子设备融合所述第一注解信息及所述第二注解信息，得到与所述第一代码文件对应的目标注解信息，所述电子设备根据所述目标注解信息及所述源码，生成所述接口信息。

其中，抽象语法树(abstract syntax tree，AST)是源代码的抽象语法结构的树状表现形式。树上的每个节点都表示源代码中的一种结构，按照预设顺序，每个节点都有其各自的编号，例如，按照语法结构的顺序或程序运行的顺序为每个节点编号。

通过上述实施方式，能够快速得到所述接口信息。

S13，根据所述接口信息，生成与所述第一代码文件对应的目标文件。

在本发明的至少一个实施例中，所述根据所述接口信息，生成与所述第一代码文件对应的目标文件包括：

所述电子设备根据所述接口信息确定接口类型，进一步地，所述电子设备从配置模板库中获取与所述接口类型对应的目标模板，将所述接口信息写入所述目标模板中，得到所述目标文件。

其中，所述接口类型表征远程过程调用、标准查询语言、文件传输、信息交付等。

由于所述接口信息是通过所述第一代码文件生成的，因此，通过上述实施方式，能够生成与所述第一代码文件对应的目标文件，另外，通过确定接口类型进而选取目标模板，能够提高所述目标文件的生成准确率。

S14，监听所述配置平台上的提交操作。

在本发明的至少一个实施例中，所述提交操作的对象可以是新项目对应的代码文件，也可以是已有项目对应的代码文件的更新版本。

在本发明的至少一个实施例中，所述电子设备在所述配置平台中插入监视代码，所述监视代码用于检测所述配置平台中是否有keypress事件或者keydown事件产生，当所述配置平台中有所述keypress事件或者所述keydown事件产生时，所述电子设备确定产生所述keypress事件或者所述keydown事件的目标按键，进一步地，所述电子设备检测所述目标按键是否为提交按键，当检测到所述目标按键为所述提交按键时，所述电子设备确定所述配置平台上有提交操作产生。

通过上述实施方式，能够实时监听所述配置平台上的提交操作，有效地避免了提交操作的遗漏。

在实际应用场景中，为了便于对代码文件进行集中管理，开发人员会将开发的代码文件都提交至所述配置平台进行保存。

S15，当所述配置平台上有提交操作产生时，从所述配置平台上获取与所述提交操作对应的第二代码文件。

在本发明的至少一个实施例中，所述第二代码文件是指所述第一代码文件的更新文件。

在本发明的至少一个实施例中，在从所述配置平台上获取与所述提交操作对应的第二代码文件之前，所述方法还包括：

所述电子设备确定产生所述提交操作的目标人物，进一步地，所述电子设备检测所述目标人物是否存在于配置名单中，当所述目标人物存在于所述配置名单中，所述电子设备确定所述目标人物具有提交权限，所述电子设备获取所述提交操作对应的文件名称，所述电子设备检测所述文件名称是否与所述项目名称一致，当所述文件名称与所述项目名称一致时，所述电子设备确定所述文件名称对应的项目与所述项目名称对应的项目一致。

其中，所述配置名单中包含负责项目开发的后端用户。

通过上述实施方式，能够避免不具有提交权限的人物对代码文件的更新，进而避免不具有提交权限的人物对接口文档的篡改，提高了接口文档的安全性，另外，由于所述配置平台上提交的代码文件对应的项目可以有多个，因此，通过检测所述文件名称与所述项目名称是否一致，能够避免获取到的第二代码文件对应的项目与第一代码文件对应的项目不一致，进而避免生成的接口文档不准确。需要强调的是，为进一步保证上述接口文档的私密和安全性，上述接口文档还可以存储于一区块链的节点中。

在其他实施例中，当同一时刻监听到多个提交操作时，所述电子设备生成并发出告警提示，当检测到所述告警提示被处理时，所述电子设备将所述多个提交操作对应的代码文件进行合并，得到所述第二代码文件。

在本发明的至少一个实施例中，所述电子设备从所述配置平台上获取与所述提交操作对应的第二代码文件包括：

所述电子设备采用埋点技术获取所述提交操作对应的日志文件，进一步地，所述电子设备解析所述日志文件，得到所述提交操作对应的存储路径，并从所述日志文件中提取文件名，更进一步地，所述电子设备根据所述文件名从所述存储路径中获取所述第二代码文件。

S16，基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码。

在本发明的至少一个实施例中，所述差异代码是指所述第一代码文件与所述第二代码文件之间不同的代码，此外，所述差异代码可以包括：所述第二代码文件与所述第一代码文件相比所增加的代码、及/或所述第二代码文件与所述第一代码文件相比所缺少的代码、及/或所述第二代码文件与所述第一代码文件相比所更改的代码。

在本发明的至少一个实施例中，所述基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码包括：

(1)所述电子设备获取所述第一代码文件的第一源码及所述第二代码文件的第二源码，并将所述第一源码与所述第二源码进行全文比对，得到所述差异代码。

(2)所述电子设备获取所述第二代码文件中以修订模式标识的源码，作为所述差异代码。

S17，从所述差异代码中提取目标字段及目标类型。

在本发明的至少一个实施例中，所述目标字段包括，但不限于：域名、协议等。

进一步地，所述目标类型包括增加类型、删除类型及更改类型。

在本发明的至少一个实施例中，所述从所述差异代码中提取目标字段及目标类型包括：

所述电子设备将所述差异代码的格式转换为预设格式，得到具有预设格式的目标代码，所述电子设备对所述目标代码进行词法解析，所述电子设备对词法解析后的目标代码进行语法解析，得到预处理代码，所述电子设备根据所述预处理代码，生成与所述差异代码对应的第二抽象语法树，所述电子设备从所述第二抽象语法树中提取所述目标字段及所述目标类型。

其中，所述预设格式是指可以生成所述第二抽象语法树的格式，由于能够将所述差异代码转换成统一的预设格式，因此，本方案不限制所述差异代码的格式，所述差异代码可以是C语言格式、也可以是JAVA语言格式等。通过对所述差异代码进行格式化，能够得到统一的预设格式，因此不管是哪种格式的差异代码，经过格式化之后，都可以转换为统一的预设格式。

进一步地，所述词法解析是将所述目标代码切成多个语元，并为每个语元分配一个编号。实际上是将所述差异代码切割成多个语元，并按照顺序为每个语元分配一个编号。

更进一步地，所述语法解析是在词法解析的基础上将各个语元组合成具有一定语法的语句，如“程序”、“表达式”等。

S18，根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档。

在本发明的至少一个实施例中，所述接口文档是指根据所述第二代码文件而生成的文档。

在本发明的至少一个实施例中，所述根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档包括：

(1)当所述目标类型为增加类型时，将所述目标字段添加至所述目标文件中，生成所述接口文档。

(2)当所述目标类型为删除类型时，将所述目标字段从所述目标文件中删除，生成所述接口文档。

(3)当所述目标类型为更改类型时，采用所述目标字段替换所述目标文件中与所述目标字段对应的数据。

通过上述实施方式，在生成所述接口文档时，无需重复生成与所述目标文件相同的接口信息，能够提高所述接口文档的生成效率，节约了所述接口文档的生成时间。

在本发明的至少一个实施例中，在生成所述接口文档后，所述方法还包括：

所述电子设备获取所述第二代码文件的版本号，所述电子设备根据所述版本号、所述项目名称及所述接口文档生成提示信息，所述电子设备采用对称加密技术加密所述提示信息，得到密文，所述电子设备将所述密文发送至指定联系人的终端设备，当检测到所述密文被成功解密时，所述电子设备在所述终端设备上显示所述接口文档。

其中，所述指定联系人是指控制接口文档生成的负责人。

通过生成所述提示信息，能够在所述接口文档生成时，提醒所述指定联系人及时查收，进而对所述提示信息进行加密，能够避免所述提示信息被篡改。

在本发明的至少一个实施例中，所述方法还包括：

所述电子设备将所述接口文档存储于预设数据库中，当监听到所述接口文档的导出操作时，从所述导出操作中获取导出格式，所述电子设备从所述预设数据库中获取与所述导出操作对应的接口文档，并根据所述导出格式导出所述接口文档。

其中，所述预设数据库中存储有多个接口文档。

进一步地，所述导出格式包括，但不限于：HTML格式、PDF格式等。

通过上述实施方式，能够根据用户需求导出相应格式的接口文档，便于所述用户查看所述接口文档。

由以上技术方案可以看出，本发明通过检测所述配置平台上的提交操作，及对所述第二代码文件进行代码分析检测，能够快速确定被修改的差异代码，进而根据所述差异代码快速修改所述目标文件，进而得到所述接口文档，由于无需重复生成与所述目标文件相同的接口信息，因此，能够提高所述接口文档的生成效率。

如图2所示，是本发明接口文档生成装置的较佳实施例的功能模块图。所述接口文档生成装置11包括提取单元110、获取单元111、遍历单元112、生成单元113、监听单元114、检测单元115、确定单元116、加密单元117、发送单元118、显示单元119、存储单元120及导出单元121。本发明所称的模块/单元是指一种能够被处理器13所获取，并且能够完成固定功能的一系列计算机程序段，其存储在存储器12中。在本实施例中，关于各模块/单元的功能将在后续的实施例中详述。

当接收到文档生成指令时，提取单元110从所述文档生成指令中提取项目名称。

在本发明的至少一个实施例中，所述文档生成指令的内容包括，但不限于：目标标签与项目名称的对应关系、指令编号等，另外，所述文档生成指令可以是由监管文档生成的负责人发出的。

在本发明的至少一个实施例中，所述提取单元110获取目标标签，进一步地，所述提取单元110从所述文档生成指令所携带的所有信息中提取与所述目标标签对应的信息，作为所述项目名称。

其中，所述目标标签对应的信息表征项目名称。

例如：文档生成指令A为“标签1：指令编号200；标签2：客户端A”，所述提取单元110确定目标标签为标签2，进一步地，所述提取单元110从“标签1：指令编号200；标签2：客户端A”中提取与所述标签2对应的“客户端A”，作为所述项目名称。

获取单元111从配置平台上获取与所述项目名称对应的第一代码文件。

在本发明的至少一个实施例中，所述配置平台上存储有项目名称与代码文件的对应关系，例如，项目名称B：代码文件。另外，所述配置平台能够把开发团队中每个成员修改的代码做一次备份，每提交或签入一次都会有记录，具有避免重复拷贝，集中管理的特点，所述配置平台可以是版本管理工具，本发明不作限制。

由于所述配置平台上存储有项目名称与代码文件的对应关系，因此，所述获取单元111能够根据所述项目名称从所述配置平台上获取所述第一代码文件。

在其他实施例中，当所述项目名称对应的代码文件有多个时，获取所述多个代码文件中每个代码文件的上传时间，及获取当前时间，所述上传时间表征代码文件被上传到所述配置平台上的时间，进一步地，所述获取单元111将距离所述当前时间最近的上传时间确定为目标上传时间，并将所述目标上传时间对应的代码文件确定为所述第一代码文件。

遍历单元112遍历所述第一代码文件，得到所述第一代码文件的接口信息。

在本发明的至少一个实施例中，所述遍历单元112遍历所述第一代码文件，得到所述第一代码文件的接口信息包括：

所述遍历单元112将所述第一代码文件的源码转换成第一抽象语法树，并遍历所述第一抽象语法树中的类及类方法，得到所述类的代码注解，所述遍历单元112解析所述类的代码注解，得到第一注解信息，基于递归遍历方法，所述遍历单元112遍历所述类对应的父类及所述父类的类方法，得到所述父类的代码注解，进一步地，所述遍历单元112解析所述父类的代码注解，得到第二注解信息，所述遍历单元112融合所述第一注解信息及所述第二注解信息，得到与所述第一代码文件对应的目标注解信息，所述遍历单元112根据所述目标注解信息及所述源码，生成所述接口信息。

其中，抽象语法树(abstract syntax tree，AST)是源代码的抽象语法结构的树状表现形式。树上的每个节点都表示源代码中的一种结构，按照预设顺序，每个节点都有其各自的编号，例如，按照语法结构的顺序或程序运行的顺序为每个节点编号。

通过上述实施方式，能够快速得到所述接口信息。

生成单元113根据所述接口信息，生成与所述第一代码文件对应的目标文件。

在本发明的至少一个实施例中，所述生成单元113根据所述接口信息，生成与所述第一代码文件对应的目标文件包括：

所述生成单元113根据所述接口信息确定接口类型，进一步地，所述生成单元113从配置模板库中获取与所述接口类型对应的目标模板，将所述接口信息写入所述目标模板中，得到所述目标文件。

其中，所述接口类型表征远程过程调用、标准查询语言、文件传输、信息交付等。

由于所述接口信息是通过所述第一代码文件生成的，因此，通过上述实施方式，能够生成与所述第一代码文件对应的目标文件，另外，通过确定接口类型进而选取目标模板，能够提高所述目标文件的生成准确率。

监听单元114监听所述配置平台上的提交操作。

在本发明的至少一个实施例中，所述提交操作的对象可以是新项目对应的代码文件，也可以是已有项目对应的代码文件的更新版本。

在本发明的至少一个实施例中，所述监听单元114在所述配置平台中插入监视代码，所述监视代码用于检测所述配置平台中是否有keypress事件或者keydown事件产生，当所述配置平台中有所述keypress事件或者所述keydown事件产生时，所述监听单元114确定产生所述keypress事件或者所述keydown事件的目标按键，进一步地，所述监听单元114检测所述目标按键是否为提交按键，当检测到所述目标按键为所述提交按键时，所述监听单元114确定所述配置平台上有提交操作产生。

通过上述实施方式，能够实时监听所述配置平台上的提交操作，有效地避免了提交操作的遗漏。

在实际应用场景中，为了便于对代码文件进行集中管理，开发人员会将开发的代码文件都提交至所述配置平台进行保存。

当所述配置平台上有提交操作产生时，所述获取单元111从所述配置平台上获取与所述提交操作对应的第二代码文件。

在本发明的至少一个实施例中，所述第二代码文件是指所述第一代码文件的更新文件。

在本发明的至少一个实施例中，在从所述配置平台上获取与所述提交操作对应的第二代码文件之前，确定单元116确定产生所述提交操作的目标人物，进一步地，检测单元115检测所述目标人物是否存在于配置名单中，当所述目标人物存在于所述配置名单中，所述确定单元116确定所述目标人物具有提交权限，所述获取单元111获取所述提交操作对应的文件名称，所述检测单元115检测所述文件名称是否与所述项目名称一致，当所述文件名称与所述项目名称一致时，所述确定单元116确定所述文件名称对应的项目与所述项目名称对应的项目一致。

其中，所述配置名单中包含负责项目开发的后端用户。

通过上述实施方式，能够避免不具有提交权限的人物对代码文件的更新，进而避免不具有提交权限的人物对接口文档的篡改，提高了接口文档的安全性，另外，由于所述配置平台上提交的代码文件对应的项目可以有多个，因此，通过检测所述文件名称与所述项目名称是否一致，能够避免获取到的第二代码文件对应的项目与第一代码文件对应的项目不一致，进而避免生成的接口文档不准确。

在其他实施例中，当同一时刻监听到多个提交操作时，所述生成单元113生成并发出告警提示，当检测到所述告警提示被处理时，将所述多个提交操作对应的代码文件进行合并，得到所述第二代码文件。

在本发明的至少一个实施例中，所述获取单元111从所述配置平台上获取与所述提交操作对应的第二代码文件包括：

所述获取单元111采用埋点技术获取所述提交操作对应的日志文件，进一步地，所述获取单元111解析所述日志文件，得到所述提交操作对应的存储路径，并从所述日志文件中提取文件名，更进一步地，所述获取单元111根据所述文件名从所述存储路径中获取所述第二代码文件。

所述检测单元115基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码。

在本发明的至少一个实施例中，所述差异代码是指所述第一代码文件与所述第二代码文件之间不同的代码，此外，所述差异代码可以包括：所述第二代码文件与所述第一代码文件相比所增加的代码、及/或所述第二代码文件与所述第一代码文件相比所缺少的代码、及/或所述第二代码文件与所述第一代码文件相比所更改的代码。

在本发明的至少一个实施例中，所述检测单元115基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码包括：

(1)所述检测单元115获取所述第一代码文件的第一源码及所述第二代码文件的第二源码，并将所述第一源码与所述第二源码进行全文比对，得到所述差异代码。

(2)所述检测单元115获取所述第二代码文件中以修订模式标识的源码，作为所述差异代码。

所述提取单元110从所述差异代码中提取目标字段及目标类型。

在本发明的至少一个实施例中，所述目标字段包括，但不限于：域名、协议等。

进一步地，所述目标类型包括增加类型、删除类型及更改类型。

在本发明的至少一个实施例中，所述提取单元110从所述差异代码中提取目标字段及目标类型包括：

所述提取单元110将所述差异代码的格式转换为预设格式，得到具有预设格式的目标代码，所述提取单元110对所述目标代码进行词法解析，所述提取单元110对词法解析后的目标代码进行语法解析，得到预处理代码，所述提取单元110根据所述预处理代码，生成与所述差异代码对应的第二抽象语法树，所述提取单元110从所述第二抽象语法树中提取所述目标字段及所述目标类型。

其中，所述预设格式是指可以生成所述第二抽象语法树的格式，由于能够将所述差异代码转换成统一的预设格式，因此，本方案不限制所述差异代码的格式，所述差异代码可以是C语言格式、也可以是JAVA语言格式等。通过对所述差异代码进行格式化，能够得到统一的预设格式，因此不管是哪种格式的差异代码，经过格式化之后，都可以转换为统一的预设格式。

进一步地，所述词法解析是将所述目标代码切成多个语元，并为每个语元分配一个编号。实际上是将所述差异代码切割成多个语元，并按照顺序为每个语元分配一个编号。

更进一步地，所述语法解析是在词法解析的基础上将各个语元组合成具有一定语法的语句，如“程序”、“表达式”等。

所述生成单元113根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档。

在本发明的至少一个实施例中，所述接口文档是指根据所述第二代码文件而生成的文档。

在本发明的至少一个实施例中，所述生成单元113根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档包括：

(1)当所述目标类型为增加类型时，所述生成单元113将所述目标字段添加至所述目标文件中，生成所述接口文档。

(2)当所述目标类型为删除类型时，所述生成单元113将所述目标字段从所述目标文件中删除，生成所述接口文档。

(3)当所述目标类型为更改类型时，所述生成单元113采用所述目标字段替换所述目标文件中与所述目标字段对应的数据。

通过上述实施方式，在生成所述接口文档时，无需重复生成与所述目标文件相同的接口信息，能够提高所述接口文档的生成效率，节约了所述接口文档的生成时间。

在本发明的至少一个实施例中，在生成所述接口文档后，所述获取单元111获取所述第二代码文件的版本号，所述生成单元113根据所述版本号、所述项目名称及所述接口文档生成提示信息，加密单元117采用对称加密技术加密所述提示信息，得到密文，发送单元118将所述密文发送至指定联系人的终端设备，当检测到所述密文被成功解密时，显示单元119在所述终端设备上显示所述接口文档。

其中，所述指定联系人是指控制接口文档生成的负责人。

通过生成所述提示信息，能够在所述接口文档生成时，提醒所述指定联系人及时查收，进而对所述提示信息进行加密，能够避免所述提示信息被篡改。

在本发明的至少一个实施例中，存储单元120将所述接口文档存储于预设数据库中，当监听到所述接口文档的导出操作时，所述获取单元111从所述导出操作中获取导出格式，所述获取单元111从所述预设数据库中获取与所述导出操作对应的接口文档，导出单元121根据所述导出格式导出所述接口文档。

其中，所述预设数据库中存储有多个接口文档。

进一步地，所述导出格式包括，但不限于：HTML格式、PDF格式等。

通过上述实施方式，能够根据用户需求导出相应格式的接口文档，便于所述用户查看所述接口文档。

由以上技术方案可以看出，本发明通过检测所述配置平台上的提交操作，及对所述第二代码文件进行代码分析检测，能够快速确定被修改的差异代码，进而根据所述差异代码快速修改所述目标文件，进而得到所述接口文档，由于无需重复生成与所述目标文件相同的接口信息，因此，能够提高所述接口文档的生成效率。

如图3所示，是本发明实现接口文档生成方法的较佳实施例的电子设备的结构示意图。

在本发明的一个实施例中，所述电子设备1包括，但不限于，存储器12、处理器13，以及存储在所述存储器12中并可在所述处理器13上运行的计算机程序，例如接口文档生成程序。

本领域技术人员可以理解，所述示意图仅仅是电子设备1的示例，并不构成对电子设备1的限定，可以包括比图示更多或更少的部件，或者组合某些部件，或者不同的部件，例如所述电子设备1还可以包括输入输出设备、网络接入设备、总线等。

所述处理器13可以是中央处理单元(Central Processing Unit，CPU)，还可以是其他通用处理器、数字信号处理器(Digital Signal Processor，DSP)、专用集成电路(Application Specific Integrated Circuit，ASIC)、现场可编程门阵列(Field-Programmable Gate Array，FPGA)或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件等。通用处理器可以是微处理器或者该处理器也可以是任何常规的处理器等，所述处理器13是所述电子设备1的运算核心和控制中心，利用各种接口和线路连接整个电子设备1的各个部分，及获取所述电子设备1的操作系统以及安装的各类应用程序、程序代码等。

所述处理器13获取所述电子设备1的操作系统以及安装的各类应用程序。所述处理器13获取所述应用程序以实现上述各个接口文档生成方法实施例中的步骤，例如图1所示的步骤。

示例性的，所述计算机程序可以被分割成一个或多个模块/单元，所述一个或者多个模块/单元被存储在所述存储器12中，并由所述处理器13获取，以完成本发明。所述一个或多个模块/单元可以是能够完成特定功能的一系列计算机程序指令段，该指令段用于描述所述计算机程序在所述电子设备1中的获取过程。例如，所述计算机程序可以被分割成提取单元110、获取单元111、遍历单元112、生成单元113、监听单元114、检测单元115、确定单元116、加密单元117、发送单元118、显示单元119、存储单元120及导出单元121。

所述存储器12可用于存储所述计算机程序和/或模块，所述处理器13通过运行或获取存储在所述存储器12内的计算机程序和/或模块，以及调用存储在存储器12内的数据，实现所述电子设备1的各种功能。所述存储器12可主要包括存储程序区和存储数据区，其中，存储程序区可存储操作系统、至少一个功能所需的应用程序(比如声音播放功能、图像播放功能等)等；存储数据区可存储根据电子设备的使用所创建的数据等。此外，存储器12可以包括非易失性存储器，例如硬盘、内存、插接式硬盘，智能存储卡(Smart Media Card,SMC)，安全数字(Secure Digital,SD)卡，闪存卡(Flash Card)、至少一个磁盘存储器件、闪存器件、或其他非易失性固态存储器件。

所述存储器12可以是电子设备1的外部存储器和/或内部存储器。进一步地，所述存储器12可以是具有实物形式的存储器，如内存条、TF卡(Trans-flash Card)等等。

所述电子设备1集成的模块/单元如果以软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本发明实现上述实施例方法中的全部或部分流程，也可以通过计算机程序来指令相关的硬件来完成，所述的计算机程序可存储于一计算机可读存储介质中，该计算机程序在被处理器获取时，可实现上述各个方法实施例的步骤。

其中，所述计算机程序包括计算机程序代码，所述计算机程序代码可以为源代码形式、对象代码形式、可获取文件或某些中间形式等。所述计算机可读介质可以包括：能够携带所述计算机程序代码的任何实体或装置、记录介质、U盘、移动硬盘、磁碟、光盘、计算机存储器、只读存储器(ROM，Read-Only Memory)。

结合图1，所述电子设备1中的所述存储器12存储多个指令以实现一种接口文档生成方法，所述处理器13可获取所述多个指令从而实现：当接收到文档生成指令时，从所述文档生成指令中提取项目名称；从配置平台上获取与所述项目名称对应的第一代码文件；遍历所述第一代码文件，得到所述第一代码文件的接口信息；根据所述接口信息，生成与所述第一代码文件对应的目标文件；监听所述配置平台上的提交操作；当所述配置平台上有提交操作产生时，从所述配置平台上获取与所述提交操作对应的第二代码文件；基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码；从所述差异代码中提取目标字段及目标类型；根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档。需要强调的是，为进一步保证上述接口文档的私密和安全性，上述接口文档还可以存储于一区块链的节点中。

具体地，所述处理器13对上述指令的具体实现方法可参考图1对应实施例中相关步骤的描述，在此不赘述。

在本发明所提供的几个实施例中，应该理解到，所揭露的系统，装置和方法，可以通过其它的方式实现。例如，以上所描述的装置实施例仅仅是示意性的，例如，所述模块的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式。

所述作为分离部件说明的模块可以是或者也可以不是物理上分开的，作为模块显示的部件可以是或者也可以不是物理单元，即可以位于一个地方，或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部模块来实现本实施例方案的目的。

另外，在本发明各个实施例中的各功能模块可以集成在一个处理单元中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个单元中。上述集成的单元既可以采用硬件的形式实现，也可以采用硬件加软件功能模块的形式实现。

本发明所指区块链是分布式数据存储、点对点传输、共识机制、加密算法等计算机技术的新型应用模式。区块链(Blockchain)，本质上是一个去中心化的数据库，是一串使用密码学方法相关联产生的数据块，每一个数据块中包含了一批次网络交易的信息，用于验证其信息的有效性(防伪)和生成下一个区块。区块链可以包括区块链底层平台、平台产品服务层以及应用服务层等。

因此，无论从哪一点来看，均应将实施例看作是示范性的，而且是非限制性的，本发明的范围由所附权利要求而不是上述说明限定，因此旨在将落在权利要求的等同要件的含义和范围内的所有变化涵括在本发明内。不应将权利要求中的任何附关联图标记视为限制所涉及的权利要求。

此外，显然“包括”一词不排除其他单元或步骤，单数不排除复数。系统权利要求中陈述的多个单元或装置也可以由一个单元或装置通过软件或者硬件来实现。第二等词语用来表示名称，而并不表示任何特定的顺序。

最后应说明的是，以上实施例仅用以说明本发明的技术方案而非限制，尽管参照较佳实施例对本发明进行了详细说明，本领域的普通技术人员应当理解，可以对本发明的技术方案进行修改或等同替换，而不脱离本发明技术方案的精神和范围。

Claims (10)

1.一种接口文档生成方法，其特征在于，所述接口文档生成方法包括：

当接收到文档生成指令时，从所述文档生成指令中提取项目名称；

从配置平台上获取与所述项目名称对应的第一代码文件；

遍历所述第一代码文件，得到所述第一代码文件的接口信息；

根据所述接口信息，生成与所述第一代码文件对应的目标文件；

监听所述配置平台上的提交操作；

当所述配置平台上有提交操作产生时，从所述配置平台上获取与所述提交操作对应的第二代码文件；

基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码；

从所述差异代码中提取目标字段及目标类型；

根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档。

2.如权利要求1所述的接口文档生成方法，其特征在于，所述遍历所述第一代码文件，得到所述第一代码文件的接口信息包括：

将所述第一代码文件的源码转换成第一抽象语法树，并遍历所述第一抽象语法树中的类及类方法，得到所述类的代码注解；

解析所述类的代码注解，得到第一注解信息；

基于递归遍历方法，遍历所述类对应的父类及所述父类的类方法，得到所述父类的代码注解；

解析所述父类的代码注解，得到第二注解信息；

融合所述第一注解信息及所述第二注解信息，得到与所述第一代码文件对应的目标注解信息；

根据所述目标注解信息及所述源码，生成所述接口信息。

3.如权利要求1所述的接口文档生成方法，其特征在于，在从所述配置平台上获取与所述提交操作对应的第二代码文件之前，所述接口文档生成方法还包括：

确定产生所述提交操作的目标人物；

检测所述目标人物是否存在于配置名单中；

当所述目标人物存在于所述配置名单中，确定所述目标人物具有提交权限；

获取所述提交操作对应的文件名称；

检测所述文件名称是否与所述项目名称一致；

当所述文件名称与所述项目名称一致时，确定所述文件名称对应的项目与所述项目名称对应的项目一致。

4.如权利要求1所述的接口文档生成方法，其特征在于，所述基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码包括：

获取所述第一代码文件的第一源码及所述第二代码文件的第二源码，将所述第一源码与所述第二源码进行全文比对，得到所述差异代码；及/或

获取所述第二代码文件中以修订模式标识的源码，作为所述差异代码。

5.如权利要求1所述的接口文档生成方法，其特征在于，所述从所述差异代码中提取目标字段及目标类型包括：

将所述差异代码的格式转换为预设格式，得到具有预设格式的目标代码；

对所述目标代码进行词法解析；

对词法解析后的目标代码进行语法解析，得到预处理代码；

根据所述预处理代码，生成与所述差异代码对应的第二抽象语法树；

从所述第二抽象语法树中提取所述目标字段及所述目标类型。

6.如权利要求1所述的接口文档生成方法，其特征在于，所述接口文档存储于区块链中，所述根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档包括：

当所述目标类型为增加类型时，将所述目标字段添加至所述目标文件中，生成所述接口文档；及/或

当所述目标类型为删除类型时，将所述目标字段从所述目标文件中删除，生成所述接口文档；及/或

当所述目标类型为更改类型时，采用所述目标字段替换所述目标文件中与所述目标字段对应的数据。

7.如权利要求1至6中任意一项所述的接口文档生成方法，其特征在于，在生成所述接口文档后，所述接口文档生成方法还包括：

获取所述第二代码文件的版本号；

根据所述版本号、所述项目名称及所述接口文档生成提示信息；

采用对称加密技术加密所述提示信息，得到密文；

将所述密文发送至指定联系人的终端设备；

当检测到所述密文被成功解密时，在所述终端设备上显示所述接口文档。

8.一种接口文档生成装置，其特征在于，所述接口文档生成装置包括：

提取单元，用于当接收到文档生成指令时，从所述文档生成指令中提取项目名称；

获取单元，用于从配置平台上获取与所述项目名称对应的第一代码文件；

遍历单元，用于遍历所述第一代码文件，得到所述第一代码文件的接口信息；

生成单元，用于根据所述接口信息，生成与所述第一代码文件对应的目标文件；

监听单元，用于监听所述配置平台上的提交操作；

所述获取单元，还用于当所述配置平台上有提交操作产生时，从所述配置平台上获取与所述提交操作对应的第二代码文件；

检测单元，用于基于所述第一代码文件，对所述第二代码文件进行代码分析检测，得到差异代码；

所述提取单元，还用于从所述差异代码中提取目标字段及目标类型；

所述生成单元，还用于根据所述目标字段及所述目标类型更新所述目标文件，生成所述接口文档。

9.一种电子设备，其特征在于，所述电子设备包括：

存储器，存储至少一个指令；及

处理器，获取所述存储器中存储的指令以实现如权利要求1至7中任意一项所述的接口文档生成方法。

10.一种计算机可读存储介质，其特征在于：所述计算机可读存储介质中存储有至少一个指令，所述至少一个指令被电子设备中的处理器获取以实现如权利要求1至7中任意一项所述的接口文档生成方法。

Images