[发明专利]一种接口文档生成方法、装置、机器可读介质及设备

说明书

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

技术领域

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

背景技术

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

发明内容

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

一个或多个处理器；和

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