CN113031925A - 一种接口文档生成方法、装置、机器可读介质及设备 - Google Patents

Abstract

本发明公开了一种接口文档生成方法，包括：定义待生成文档的文档格式；获取至少一个接口的接口数据；从文档生成插件库中选择至少一个文档生成插件作为目标文档生成插件；采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档。本发明通过上述方法可以快速生成接口文档，极大的提高了原来人工撰写文档的效率。

Description

一种接口文档生成方法、装置、机器可读介质及设备

技术领域

本发明涉及人工智能领域，具体涉及一种接口文档生成方法、装置、机器可读介质及设备。

背景技术

在软件开发过程中，当接口较多时，通常需要花费很长时间来撰写接口文档，效率低下，费时费力。且现有的文档导出方法导出的文档格式混乱、层次不清、可读性极差，无法满足项目管理需要。

发明内容

鉴于以上所述现有技术的缺点，本发明的目的在于提供一种接口文档生成方法、装置、机器可读介质及设备，用于解决现有技术存在的问题。

为实现上述目的及其他相关目的，本发明提供一种接口文档生成方法，包括：

定义待生成文档的文档格式；

获取至少一个接口的接口数据；

从文档生成插件库中选择至少一个文档生成插件作为目标文档生成插件；

采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档。

可选地，所述文档格式包括以下至少之一：标题格式、段落标题格式、段落格式、图表格式、文字格式、表格格式、图片格式。

可选地，在采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档步骤前，还包括：对至少部分接口数据进行第一次格式转换。

可选地，该方法还包括：对进行第一次格式转换后的接口数据进行第二次格式转换。

可选地，将所述至少一个接口的接口数据对应的业务功能相关联的至少一个文档生成插件作为目标文档生成插件。

为实现上述目的及其他相关目的，本发明提供一种接口文档生成装置，包括：

文档格式定义模块，用于定义待生成文档的文档格式；

接口数据获取模块，用于获取至少一个接口的接口数据；

目标文档生成插件选择模块，用于从文档生成插件库中选择至少一个文档生成插件作为目标文档生成插件；

接口文档生成模块，用于采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档。

可选地，所述文档格式包括以下至少之一：标题格式、段落标题格式、段落格式、图表格式、文字格式、表格格式、图片格式。

可选地，该装置还包括：第一格式转换模块，用于在采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档步骤前，对至少部分接口数据进行第一次格式转换。

可选地，该装置还包括：第二格式转换模块，用于对进行第一次格式转换后的接口数据进行第二次格式转换。

可选地，将接口文档生成模块根据所述至少一个接口的接口数据对应的业务功能相关联的至少一个文档生成插件作为目标文档生成插件。

为实现上述目的及其他相关目的，本发明还提供一种电子设备，包括：

一个或多个处理器；和

其上存储有指令的一个或多个机器可读介质，当所述一个或多个处理器执行时，使得所述设备执行前述的一个或多个所述的方法。

为实现上述目的及其他相关目的，本发明还提供一个或多个机器可读介质，其上存储有指令，当由一个或多个处理器执行时，使得设备执行前述的一个或多个所述的方法。

如上所述，本发明提供的一种接口文档生成方法、装置、机器可读介质及设备，具有以下有益效果：

本发明的一种接口文档生成方法，包括：定义待生成文档的文档格式；获取至少一个接口的接口数据；从文档生成插件库中选择至少一个文档生成插件作为目标文档生成插件；采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档。本发明通过上述方法可以快速生成接口文档，极大的提高了原来人工撰写文档的效率。

附图说明

图1为本发明一实施例一种接口文档生成方法的流程图；

图2为本发明一实施例一种接口文档生成装置的硬件结构示意图；

图3为本发明一实施例中终端设备的硬件结构示意图；

图4为本发明一实施例中终端设备的硬件结构示意图。

具体实施方式

以下通过特定的具体实例说明本发明的实施方式，本领域技术人员可由本说明书所揭露的内容轻易地了解本发明的其他优点与功效。本发明还可以通过另外不同的具体实施方式加以实施或应用，本说明书中的各项细节也可以基于不同观点与应用，在没有背离本发明的精神下进行各种修饰或改变。需说明的是，在不冲突的情况下，以下实施例及实施例中的特征可以相互组合。

需要说明的是，以下实施例中所提供的图示仅以示意方式说明本发明的基本构想，遂图式中仅显示与本发明中有关的组件而非按照实际实施时的组件数目、形状及尺寸绘制，其实际实施时各组件的型态、数量及比例可为一种随意的改变，且其组件布局型态也可能更为复杂。

如图1所示，本申请实施例提供一种接口文档生成方法，包括：

S11定义待生成文档的文档格式；

S12获取至少一个接口的接口数据；

S13从文档生成插件库中选择至少一个文档生成插件作为目标文档生成插件；

S14采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档。

通过上述方法可以快速生成接口文档，极大的提高了原来人工撰写文档的效率。

在一实施例中，所述文档格式包括以下至少之一：标题格式、段落标题格式、段落格式、图表格式、文字格式、表格格式、图片格式。

具体的，在生成接口文档的过程中，需要首先确定要生成的接口文档的格式，包括标题、段落标题、段落、图表、表格、文字中的一个或多个的组合方式，即接口文档的格式为一种组合方式，该组合方式中包括标题、段落标题、段落、图表、文字、表格中的一个或多个。可以理解的是，不同的接口文档需要不同的格式，其中，若两个接口文档中的标题、段落标题、段落有任何一个不同即认为这两个接口文档为两个不同的接口文档。还可以理解的是，一个段落可以没有段落标题，但是一个段落标题至少对应一个段落。所述标题格式可以包括多级标题，设置生成文档时每一级标题的字体、字号和缩进。所述图表格式可以包括：折线图、散点图、条形图或柱状图中的一个或多个；对表格格式可以包括生成文档时表格的表头格式、表体的格式，格式包括字体、字号、边框和对齐；所述文字格式可以包括：字体、字号、颜色、字形、效果中的一个或多个；对图片格式可以包括生成文档时图片的对齐方式，包括左对齐、右对齐和居中。

在一实施例中，在采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档步骤前，还包括：对至少部分接口数据进行第一次格式转换。

具体的，对接口数据中表示特殊含义的数据处理成能让文档阅读者通俗易懂的文字，提高文档可读性。

在一实施例中，该方法还包括：对进行第一次格式转换后的接口数据进行第二次格式转换。

具体地，将处理完成的接口数据生成为符合导出插件要求的数据。

在一实施例中，将所述至少一个接口的接口数据对应的业务功能相关联的至少一个文档生成插件作为目标文档生成插件。

需要说明的是，所述接口数据必定归属于某一业务功能，在具体实施过程中，可以预先建立业务功能和文档生成插件的关联关系，然后在获取接口数据后，通过查表等方式，得到所述接口数据归属的业务功能，然后根据业务功能得到与所述业务功能相关联的文档生成插件作为目标文档生成插件。如果根据业务功能得到与所述业务功能相关联的文档生成插件包括多个文档生成插件，则随机从这多个文档生成插件中的一个作为目标文档生成插件。

例如，将文档生成插件的业务功能填写为工作周报，建立该文档生成插件与工作周报业务功能的关联关系，在获取与所述接口数据对应的业务功能相关联的文档生成插件时，所述接口数据归属的业务功能为工作周报，则根据关联关系，得到业务功能为工作周报的文档生成插件。

又例如，将某一文档生成插件定义为第一文档生成插件，文档生成插件编号为1，建立文档生成插件编号与业务功能对应关系表，表中文档生成插件编号1对应工作周报业务功能，在获取与所述接口数据对应的业务功能相关联的文档生成插件时，所述接口数据归属的业务功能为工作周报，则根据对应关系表中的关联关系，得到文档生成插件编号为1的第一文档生成插件，将所述第一文档生成插件作为目标文档生成插件。如果根据业务功能得到与所述业务功能相关联的文档生成插件包括多个文档生成插件，则随机从这多个文档生成插件中的一个作为目标文档生成插件。

在确定好接口文档的格式以及目标文档生成插件后，利用目标文档生成插件以及接口数据生成接口文档。

例如，先定义标题的字体大小、颜色、缩进等，通过接口拿到标题的文字，再对标题的文字应用定义好的样式。

如图2所示，本申请实施例提供一种接口文档生成装置，包括：

文档格式定义模块21，用于定义待生成文档的文档格式；

接口数据获取模块22，用于获取至少一个接口的接口数据；

目标文档生成插件选择模块23，用于从文档生成插件库中选择至少一个文档生成插件作为目标文档生成插件；

接口文档生成模块24，用于采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档。

通过上述方法可以快速生成接口文档，极大的提高了原来人工撰写文档的效率。

在一实施例中，所述文档格式包括以下至少之一：标题格式、段落标题格式、段落格式、图表格式、文字格式、表格格式、图片格式。

具体的，在生成接口文档的过程中，需要首先确定要生成的接口文档的格式，包括标题、段落标题、段落、图表、表格、文字中的一个或多个的组合方式，即接口文档的格式为一种组合方式，该组合方式中包括标题、段落标题、段落、图表、文字、表格中的一个或多个。可以理解的是，不同的接口文档需要不同的格式，其中，若两个接口文档中的标题、段落标题、段落有任何一个不同即认为这两个接口文档为两个不同的接口文档。还可以理解的是，一个段落可以没有段落标题，但是一个段落标题至少对应一个段落。所述标题格式可以包括多级标题，设置生成文档时每一级标题的字体、字号和缩进。所述图表格式可以包括：折线图、散点图、条形图或柱状图中的一个或多个；对表格格式可以包括生成文档时表格的表头格式、表体的格式，格式包括字体、字号、边框和对齐；所述文字格式可以包括：字体、字号、颜色、字形、效果中的一个或多个；对图片格式可以包括生成文档时图片的对齐方式，包括左对齐、右对齐和居中。

在一实施例中，该装置还包括：第一格式转换模块，用于在采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档步骤前，对至少部分接口数据进行第一次格式转换。

具体地，对接口数据中表示特殊含义的数据处理成能让文档阅读者通俗易懂的文字，提高文档可读性。

在一实施例中，该装置还包括：第二格式转换模块，用于对进行第一次格式转换后的接口数据进行第二次格式转换。

具体地，将处理完成的接口数据生成为符合导出插件要求的数据。

在一实施例中，将所述至少一个接口的接口数据对应的业务功能相关联的至少一个文档生成插件作为目标文档生成插件。

需要说明的是，所述接口数据必定归属于某一业务功能，在具体实施过程中，可以预先建立业务功能和文档生成插件的关联关系，然后在获取接口数据后，通过查表等方式，得到所述接口数据归属的业务功能，然后根据业务功能得到与所述业务功能相关联的文档生成插件作为目标文档生成插件。如果根据业务功能得到与所述业务功能相关联的文档生成插件包括多个文档生成插件，则随机从这多个文档生成插件中的一个作为目标文档生成插件。

例如，将文档生成插件的业务功能填写为工作周报，建立该文档生成插件与工作周报业务功能的关联关系，在获取与所述接口数据对应的业务功能相关联的文档生成插件时，所述接口数据归属的业务功能为工作周报，则根据关联关系，得到业务功能为工作周报的文档生成插件。

又例如，将某一文档生成插件定义为第一文档生成插件，文档生成插件编号为1，建立文档生成插件编号与业务功能对应关系表，表中文档生成插件编号1对应工作周报业务功能，在获取与所述接口数据对应的业务功能相关联的文档生成插件时，所述接口数据归属的业务功能为工作周报，则根据对应关系表中的关联关系，得到文档生成插件编号为1的第一文档生成插件，将所述第一文档生成插件作为目标文档生成插件。如果根据业务功能得到与所述业务功能相关联的文档生成插件包括多个文档生成插件，则随机从这多个文档生成插件中的一个作为目标文档生成插件。

在确定好接口文档的格式以及目标文档生成插件后，利用目标文档生成插件以及接口数据生成接口文档。

例如，先定义标题的字体大小、颜色、缩进等，通过接口拿到标题的文字，再对标题的文字应用定义好的样式。

本申请实施例还提供了一种设备，该设备可以包括：一个或多个处理器；和其上存储有指令的一个或多个机器可读介质，当由所述一个或多个处理器执行时，使得所述设备执行图1所述的方法。在实际应用中，该设备可以作为终端设备，也可以作为服务器，终端设备的例子可以包括：智能手机、平板电脑、电子书阅读器、MP3(动态影像专家压缩标准语音层面3，Moving Picture Experts Group Audio Layer III)播放器、MP4(动态影像专家压缩标准语音层面4，Moving Picture Experts Group Audio Layer IV)播放器、膝上型便携计算机、车载电脑、台式计算机、机顶盒、智能电视机、可穿戴设备等等，本申请实施例对于具体的设备不加以限制。

本申请实施例还提供了一种非易失性可读存储介质，该存储介质中存储有一个或多个模块(programs)，该一个或多个模块被应用在设备时，可以使得该设备执行本申请实施例的图1中方法所包含步骤的指令(instructions)。

图3为本申请一实施例提供的终端设备的硬件结构示意图。如图所示，该终端设备可以包括：输入设备1100、第一处理器1101、输出设备1102、第一存储器1103和至少一个通信总线1104。通信总线1104用于实现元件之间的通信连接。第一存储器1103可能包含高速RAM存储器，也可能还包括非易失性存储NVM，例如至少一个磁盘存储器，第一存储器1103中可以存储各种程序，用于完成各种处理功能以及实现本实施例的方法步骤。

可选的，上述第一处理器1101例如可以为中央处理器(Central ProcessingUnit，简称CPU)、应用专用集成电路(ASIC)、数字信号处理器(DSP)、数字信号处理设备(DSPD)、可编程逻辑器件(PLD)、现场可编程门阵列(FPGA)、控制器、微控制器、微处理器或其他电子元件实现，该第一处理器1101通过有线或无线连接耦合到上述输入设备1100和输出设备1102。

可选的，上述输入设备1100可以包括多种输入设备，例如可以包括面向用户的用户接口、面向设备的设备接口、软件的可编程接口、摄像头、传感器中至少一种。可选的，该面向设备的设备接口可以是用于设备与设备之间进行数据传输的有线接口、还可以是用于设备与设备之间进行数据传输的硬件插入接口(例如USB接口、串口等)；可选的，该面向用户的用户接口例如可以是面向用户的控制按键、用于接收语音输入的语音输入设备以及用户接收用户触摸输入的触摸感知设备(例如具有触摸感应功能的触摸屏、触控板等)；可选的，上述软件的可编程接口例如可以是供用户编辑或者修改程序的入口，例如芯片的输入引脚接口或者输入接口等；输出设备1102可以包括显示器、音响等输出设备。

在本实施例中，该终端设备的处理器包括用于执行各设备中各模块的功能，具体功能和技术效果参照上述实施例即可，此处不再赘述。

图4为本申请的一个实施例提供的终端设备的硬件结构示意图。图4是对图3在实现过程中的一个具体的实施例。如图所示，本实施例的终端设备可以包括第二处理器1201以及第二存储器1202。

第二处理器1201执行第二存储器1202所存放的计算机程序代码，实现上述实施例中图1所述方法。

第二存储器1202被配置为存储各种类型的数据以支持在终端设备的操作。这些数据的示例包括用于在终端设备上操作的任何应用程序或方法的指令，例如消息，图片，视频等。第二存储器1202可能包含随机存取存储器(random access memory，简称RAM)，也可能还包括非易失性存储器(non-volatile memory)，例如至少一个磁盘存储器。

可选地，第二处理器1201设置在处理组件1200中。该终端设备还可以包括：通信组件1203，电源组件1204，多媒体组件1205，语音组件1206，输入/输出接口1207和/或传感器组件1208。终端设备具体所包含的组件等依据实际需求设定，本实施例对此不作限定。

处理组件1200通常控制终端设备的整体操作。处理组件1200可以包括一个或多个第二处理器1201来执行指令，以完成上述数据处理方法中的全部或部分步骤。此外，处理组件1200可以包括一个或多个模块，便于处理组件1200和其他组件之间的交互。例如，处理组件1200可以包括多媒体模块，以方便多媒体组件1205和处理组件1200之间的交互。

电源组件1204为终端设备的各种组件提供电力。电源组件1204可以包括电源管理系统，一个或多个电源，及其他与为终端设备生成、管理和分配电力相关联的组件。

多媒体组件1205包括在终端设备和用户之间的提供一个输出接口的显示屏。在一些实施例中，显示屏可以包括液晶显示器(LCD)和触摸面板(TP)。如果显示屏包括触摸面板，显示屏可以被实现为触摸屏，以接收来自用户的输入信号。触摸面板包括一个或多个触摸传感器以感测触摸、滑动和触摸面板上的手势。所述触摸传感器可以不仅感测触摸或滑动动作的边界，而且还检测与所述触摸或滑动操作相关的持续时间和压力。

语音组件1206被配置为输出和/或输入语音信号。例如，语音组件1206包括一个麦克风(MIC)，当终端设备处于操作模式，如语音识别模式时，麦克风被配置为接收外部语音信号。所接收的语音信号可以被进一步存储在第二存储器1202或经由通信组件1203发送。在一些实施例中，语音组件1206还包括一个扬声器，用于输出语音信号。

输入/输出接口1207为处理组件1200和外围接口模块之间提供接口，上述外围接口模块可以是点击轮，按钮等。这些按钮可包括但不限于：音量按钮、启动按钮和锁定按钮。

传感器组件1208包括一个或多个传感器，用于为终端设备提供各个方面的状态评估。例如，传感器组件1208可以检测到终端设备的打开/关闭状态，组件的相对定位，用户与终端设备接触的存在或不存在。传感器组件1208可以包括接近传感器，被配置用来在没有任何的物理接触时检测附近物体的存在，包括检测用户与终端设备间的距离。在一些实施例中，该传感器组件1208还可以包括摄像头等。

通信组件1203被配置为便于终端设备和其他设备之间有线或无线方式的通信。终端设备可以接入基于通信标准的无线网络，如WiFi，2G或3G，或它们的组合。在一个实施例中，该终端设备中可以包括SIM卡插槽，该SIM卡插槽用于插入SIM卡，使得终端设备可以登录GPRS网络，通过互联网与服务器建立通信。

由上可知，在图4实施例中所涉及的通信组件1203、语音组件1206以及输入/输出接口1207、传感器组件1208均可以作为图3实施例中的输入设备的实现方式。

上述实施例仅例示性说明本发明的原理及其功效，而非用于限制本发明。任何熟悉此技术的人士皆可在不违背本发明的精神及范畴下，对上述实施例进行修饰或改变。因此，举凡所属技术领域中具有通常知识者在未脱离本发明所揭示的精神与技术思想下所完成的一切等效修饰或改变，仍应由本发明的权利要求所涵盖。

Claims (12)

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

定义待生成文档的文档格式；

获取至少一个接口的接口数据；

从文档生成插件库中选择至少一个文档生成插件作为目标文档生成插件；

采用所述至少一个目标文档生成插件，根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档。

2.根据权利要求1所述的接口文档生成方法，其特征在于，所述文档格式包括以下至少之一：标题格式、段落标题格式、段落格式、图表格式、文字格式、表格格式、图片格式。

3.根据权利要求1所述的接口文档生成方法，其特征在于，在采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档步骤前，还包括：对至少部分接口数据进行第一次格式转换。

4.根据权利要求3所述的接口文档生成方法，其特征在于，该方法还包括：对进行第一次格式转换后的接口数据进行第二次格式转换。

5.根据权利要求1所述的接口文档生成方法，其特征在于，将所述至少一个接口的接口数据对应的业务功能相关联的至少一个文档生成插件作为目标文档生成插件。

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

文档格式定义模块，用于定义待生成文档的文档格式；

接口数据获取模块，用于获取至少一个接口的接口数据；

目标文档生成插件选择模块，用于从文档生成插件库中选择至少一个文档生成插件作为目标文档生成插件；

接口文档生成模块，用于采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档。

7.根据权利要求6所述的接口文档生成装置，其特征在于，所述文档格式包括以下至少之一：标题格式、段落标题格式、段落格式、图表格式、文字格式、表格格式、图片格式。

8.根据权利要求6所述的接口文档生成装置，其特征在于，该装置还包括：第一格式转换模块，用于在采用所述至少一个目标文档生成插件根据所述文档格式以及至少一个接口的接口数据生成至少一个接口文档步骤前，对至少部分接口数据进行第一次格式转换。

9.根据权利要求8所述的接口文档生成装置，其特征在于，该装置还包括：第二格式转换模块，用于对进行第一次格式转换后的接口数据进行第二次格式转换。

10.根据权利要求6所述的接口文档生成装置，其特征在于，将所述至少一个接口的接口数据对应的业务功能相关联的至少一个文档生成插件作为目标文档生成插件。

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

一个或多个处理器；和

其上存储有指令的一个或多个机器可读介质，当所述一个或多个处理器执行时，使得所述设备执行如权利要求1-5中一个或多个所述的方法。

12.一个或多个机器可读介质，其特征在于，其上存储有指令，当由一个或多个处理器执行时，使得设备执行如权利要求1-5中一个或多个所述的方法。

Images