CN111290996A - 文档格式转换方法、装置、设备及可读存储介质 - Google Patents

Abstract

本发明公开了一种文档格式转换方法、装置、设备及可读存储介质，涉及互联网技术领域，可以通过运行格式转换文件，对目标文档的内容进行标记，生成目标文档的Markdown文件，进而对Markdown文件进行格式转换，生成指定转换格式的指定文档，使得直接输出Word格式或者PDF格式的文档，无需再执行其他的格式转换操作，提高了生成的文档的兼容性，降低了团队之间的沟通成本。所述方法包括：运行格式转换文件，在格式转换文件对应的文档调取路径中获取目标文档；基于格式转换文件，对目标文档的内容进行标记，生成目标文档的Markdown文件；确定用户的指定转换格式，对Markdown文件进行格式转换，生成指定转换格式的指定文档。

Description

文档格式转换方法、装置、设备及可读存储介质

技术领域

本发明涉及互联网技术领域，特别是涉及一种文档格式转换方法、装置、设备及可读存储介质。

背景技术

在目前的互联网技术中，Swagger(文档书写框架)是开发最常用的API(Application Programming Interface，应用程序编程接口)文档编写框架，可用于前后端分离，测试mock(虚拟)等等很多打通开发流程的功能。通过编写Swagger描述代码，就可以自动生成接口文档和客户端服务端代码，做到调用端代码、服务端代码以及接口文档的一致性。

相关技术中，Swagger在生成文档时，需要使用Swagger基于框架生成一个网页，用当前域名+Swagger-ui.html作为地址，在网页中列出当前项目中所有的控制层的接口，也即生成HTML(Hyper Text Markup Language，超文本标记语言)格式的文档。

在实现本发明的过程中，发明人发现相关技术至少存在以下问题：

HTML格式的文档中提供的接口入参和出参是JSON(Java Script ObjectNotation，直译式脚本语言对象简谱)格式的，而且很混乱，无法直接拿来使用，还需要进一步的进行格式的转换才可以保证文档正常流通，导致生成的文档兼容性较低，增加了团队之间的沟通成本。

发明内容

有鉴于此，本发明提供了一种文档格式转换方法、装置、设备及可读存储介质，主要目的在于解决目前生成的文档兼容性较低，增加了团队之间的沟通成本的问题。

依据本发明第一方面，提供了一种文档格式转换方法，该方法包括：

运行格式转换文件，在所述格式转换文件对应的文档调取路径中获取目标文档，所述格式转换文件至少包括对所述目标文档的内容进行标记的配置参数；

基于所述格式转换文件，对所述目标文档的内容进行标记，生成所述目标文档的Markdown文件；

确定用户的指定转换格式，对所述Markdown文件进行格式转换，生成所述指定转换格式的指定文档。

在另一个实施例中，所述运行格式转换文件，在所述格式转换文件对应的文档调取路径中获取目标文档之前，所述方法还包括：

获取当前项目的配置文件，在所述配置文件中设置用于对文档中内容进行标记的所述配置参数，生成初始文件，所述配置参数至少为Swagger的参数；

在所述初始文件中添加所述配置参数的运行代码，生成所述格式转换文件；

确定所述当前项目对应的所述文档调取路径，将所述文档调取路径与所述格式转换文件进行关联。

在另一个实施例中，所述运行格式转换文件，在所述格式转换文件对应的文档调取路径中获取目标文档，包括：

在数据仓库中引入启动插件，基于所述启动插件对所述格式转换文件的运行代码进行调用，运行所述格式转换文件的配置参数；

获取所述格式转换文件关联的所述文档调取路径，在所述文档调取路径指示的位置提取所述目标文档。

在另一个实施例中，所述基于所述格式转换文件，对所述目标文档的内容进行标记，生成所述目标文档的Markdown文件，包括：

对所述目标文档进行内容描述，生成所述目标文档的描述文件，所述描述文件至少包括所述目标文档的文档标题字段、入参接口字段、出参接口字段、文档类型字段或描述内容字段；

根据所述描述文件的在所述目标文档中指示的内容，将所述描述文件标注在所述目标文档上，生成所述Markdown文件。

在另一个实施例中，所述对所述目标文档进行内容描述，生成所述目标文档的描述文件，包括：

读取所述目标文档包括的全部代码字段的功能，将所述全部代码字段中相邻且功能相同的代码字段划分为一组，得到多个代码字段组；

分别对所述多个代码字段组进行运行功能的描述，得到所述多个代码字段组的多个描述字段；

将所述多个描述字段打包，生成所述描述文件。

在另一个实施例中，所述确定用户的指定转换格式，对所述Markdown文件进行格式转换，生成所述指定转换格式的指定文档之前，所述方法还包括：

引入格式转换工具，所述格式转换工具用于将所述Markdown文件转换为Word格式或PDF格式；

按照所述格式转换工具的运行要求，为所述格式转换工具设置环境变量。

在另一个实施例中，所述确定用户的指定转换格式，对所述Markdown文件进行格式转换，生成所述指定转换格式的指定文档，包括：

接收所述用户的格式转换指令，在所述格式转换指令中提取所述指定转换格式，所述指定转换格式至少为所述Word格式或所述PDF格式中的任一种；

在所述环境变量中启动所述格式转换工具；

调用所述格式转换工具，将所述Markdown文件转换为所述指定转换格式的指定文档。

依据本发明第二方面，提供了一种文档格式转换装置，该装置包括：

运行模块，用于运行格式转换文件，在所述格式转换文件对应的文档调取路径中获取目标文档，所述格式转换文件至少包括对所述目标文档的内容进行标记的配置参数；

第一生成模块，用于基于所述格式转换文件，对所述目标文档的内容进行标记，生成所述目标文档的Markdown文件；

转换模块，用于确定用户的指定转换格式，对所述Markdown文件进行格式转换，生成所述指定转换格式的指定文档。

在另一个实施例中，所述装置还包括：

获取模块，用于获取当前项目的配置文件，在所述配置文件中设置用于对文档中内容进行标记的所述配置参数，生成初始文件，所述配置参数至少为Swagger的参数；

第二生成模块，用于在所述初始文件中添加所述配置参数的运行代码，生成所述格式转换文件；

关联模块，用于确定所述当前项目对应的所述文档调取路径，将所述文档调取路径与所述格式转换文件进行关联。

在另一个实施例中，所述运行模块，包括：

调用单元，用于在数据仓库中引入启动插件，基于所述启动插件对所述格式转换文件的运行代码进行调用，运行所述格式转换文件的配置参数；

提取单元，用于获取所述格式转换文件关联的所述文档调取路径，在所述文档调取路径指示的位置提取所述目标文档。

在另一个实施例中，所述第一生成模块，包括：

描述单元，用于对所述目标文档进行内容描述，生成所述目标文档的描述文件，所述描述文件至少包括所述目标文档的文档标题字段、入参接口字段、出参接口字段、文档类型字段或描述内容字段；

标注单元，用于根据所述描述文件的在所述目标文档中指示的内容，将所述描述文件标注在所述目标文档上，生成所述Markdown文件。

在另一个实施例中，所述描述单元，用于读取所述目标文档包括的全部代码字段的功能，将所述全部代码字段中相邻且功能相同的代码字段划分为一组，得到多个代码字段组；分别对所述多个代码字段组进行运行功能的描述，得到所述多个代码字段组的多个描述字段；将所述多个描述字段打包，生成所述描述文件。

在另一个实施例中，所述装置还包括：

引入模块，用于引入格式转换工具，所述格式转换工具用于将所述Markdown文件转换为Word格式或PDF格式；

设置模块，用于按照所述格式转换工具的运行要求，为所述格式转换工具设置环境变量。

在另一个实施例中，所述转换模块，用于接收所述用户的格式转换指令，在所述格式转换指令中提取所述指定转换格式，所述指定转换格式至少为所述Word格式或所述PDF格式中的任一种；在所述环境变量中启动所述格式转换工具；调用所述格式转换工具，将所述Markdown文件转换为所述指定转换格式的指定文档。

依据本发明第三方面，提供了一种设备，包括存储器和处理器，所述存储器存储有计算机程序，所述处理器执行所述计算机程序时实现上述第一方面所述方法的步骤。

依据本发明第四方面，提供了一种可读存储介质，其上存储有计算机程序，所述计算机程序被处理器执行时实现上述第一方面所述的方法的步骤。

借由上述技术方案，本发明提供的一种文档格式转换方法、装置、设备及可读存储介质，本发明可以通过运行格式转换文件，在格式转换文件对应的文档调取路径中获取目标文档，并基于格式转换文件，对目标文档的内容进行标记，生成目标文档的Markdown文件，进而对Markdown文件进行格式转换，生成指定转换格式的指定文档，使得可以直接输出Word格式或者PDF格式的文档，无需再执行其他的格式转换操作，提高了生成的文档的兼容性，降低了团队之间的沟通成本。

上述说明仅是本发明技术方案的概述，为了能够更清楚了解本发明的技术手段，而可依照说明书的内容予以实施，并且为了让本发明的上述和其它目的、特征和优点能够更明显易懂，以下特举本发明的具体实施方式。

附图说明

通过阅读下文优选实施方式的详细描述，各种其他的优点和益处对于本领域普通技术人员将变得清楚明了。附图仅用于示出优选实施方式的目的，而并不认为是对本发明的限制。而且在整个附图中，用相同的参考符号表示相同的部件。在附图中：

图1示出了本发明实施例提供的一种文档格式转换方法流程示意图；

图2A示出了本发明实施例提供的一种文档格式转换方法流程示意图；

图2B示出了本发明实施例提供的一种文档格式转换方法的示意图；

图2C示出了本发明实施例提供的一种文档格式转换方法的示意图；

图2D示出了本发明实施例提供的一种文档格式转换方法的示意图；

图2E示出了本发明实施例提供的一种文档格式转换方法流程示意图；

图3A示出了本发明实施例提供的一种文档格式转换装置的结构示意图；

图3B示出了本发明实施例提供的一种文档格式转换装置的结构示意图；

图3C示出了本发明实施例提供的一种文档格式转换装置的结构示意图；

图3D示出了本发明实施例提供的一种文档格式转换装置的结构示意图；

图3E示出了本发明实施例提供的一种文档格式转换装置的结构示意图；

图4示出了本发明实施例提供的一种设备的装置结构示意图。

具体实施方式

下面将参照附图更详细地描述本发明的示例性实施例。虽然附图中显示了本发明的示例性实施例，然而应当理解，可以以各种形式实现本发明而不应被这里阐述的实施例所限制。相反，提供这些实施例是为了能够更透彻地理解本发明，并且能够将本发明的范围完整的传达给本领域的技术人员。

本发明实施例提供了一种文档格式转换方法，如图1所示，该方法包括：

101、运行格式转换文件，在格式转换文件对应的文档调取路径中获取目标文档，格式转换文件至少包括对目标文档的内容进行标记的配置参数。

102、基于格式转换文件，对目标文档的内容进行标记，生成目标文档的Markdown文件。

103、确定用户的指定转换格式，对Markdown文件进行格式转换，生成指定转换格式的指定文档。

其中，Markdown文件是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。

本发明实施例提供的方法，可以通过运行格式转换文件，在格式转换文件对应的文档调取路径中获取目标文档，并基于格式转换文件，对目标文档的内容进行标记，生成目标文档的Markdown文件，进而对Markdown文件进行格式转换，生成指定转换格式的指定文档，使得可以直接输出Word格式或者PDF格式的文档，无需再执行其他的格式转换操作，提高了生成的文档的兼容性，降低了团队之间的沟通成本。

本发明实施例提供了一种文档格式转换方法，如图2A所示，该方法包括：

201、建立格式转换文件。

发明人认识到，Swagger是开发最常用的API文档编写框架，可用于前后端分离，测试mock等等很多打通开发流程的功能，一般来说，在导出文档时，都是使用swagger-UI基于框架生成一个网页，用当前域名+swagger-ui.html作为地址，在网页中列出当前项目中所有的Controller(控制)层的接口，也即生成HTML格式的文档，但是HTML格式的文档中的内容都是混乱的，实质上就是代码形式的文档，文档中包括大量的函数、公式、文字等，这些函数、公式、文字等均混杂在一起，不能直接使用，因此，在本发明中，先基于Swagger框架以及组件等，将文档转换为具有标记性语言特性的Markdown(标记语言)文件，随后，在Markdown文件的基础上进行格式转换，得到其他格式的文档。

需要说明的是，由于整个发明都是需要依赖Swagger框架的，因此，在执行本发明之前，需要先搭建Swagger框架，为后端开发建立格式转换文件提供基础。其中，搭建Swagger框架的核心代码如图2B中的代码所示，过程可以概括如下：将Swagger框架的配置文件存储在数据仓库中，并为该配置文件设置在仓库中的GroupId(域名)、ArtifactId(项目名)和Version(版本号)。当需要运行该Swagger框架时，考虑到随着Swagger框架的升级，数据仓库中可能存在多个不同版本的Swagger框架，因此，需要按照当前待使用的Swagger框架的GroupId、ArtifactId和Version在仓库中进行调用。

由于本发明是以Swagger为基础实现的，且Swagger的配置参数可以对文档的内容进行标记进而生成Markdown文件，因此，需要在项目的配置文件中添加入关于Swagger的参数以及用于启动Swagger的相关代码文件，建立用于生成Markdown文件的格式转换文件，从而保证Swagger在整个项目中的正常运行。其中，每个项目都会有其对应的配置文件，为了在该项目中设置Swagger，需要获取当前项目的配置文件，在配置文件中设置用于对文档中内容进行标记的配置参数，也即Swagger的参数，从而生成初始文件。随后，为了保证配置文件中Swagger的参数可以正常运行，还需要在初始文件中添加配置参数的运行代码，生成格式转换文件。例如，可以在项目的application.yml(应用)配置文件中设置Swagger的WebPackage(网络包)、API Package(Application Programming Interface Package，应用程序编程接口包)、Title(标题)、Description(描述)、URL(Uniform Resource Locator，统一资源定位符)、Terms Of Service URL(服务条款网址)、Contact(数据连接)、Name(名称)、Email(邮件)、Version(版本号)等一系列参数，完成Swagger的相关配置的设置。随后，在该项目的配置文件中添加用于启动Swagger的Swagger2Config(文档书写框架2配置)代码文件，也即运行代码，使Swagger的相关配置可以运行。

在实际应用的过程中，考虑到项目中有些文档是内部的文档，而有些文档是外部的文档，且内部和外部文档的获取接口是不同的，因此，在建立了格式转换文件后，还需要为该格式转换文件设置调取文档的文档调取路径，也即为该格式转换文件设置接口分组以及路径，将文档调取路径与格式转换文件进行关联，保证格式转换文件调取文档时的准确性，避免后续文档的转换发生错误。

202、运行格式转换文件，在格式转换文件对应的文档调取路径中获取目标文档。

在本发明实施例中，当完成了格式转换文件的建立后，便可以运行该格式转换文件，从而获取到需要进行格式转换的目标文档，以便在后续对该目标文档进行格式转换操作。其中，为了保证格式转换文件的正常运行，需要在数据仓库中引入启动插件，基于启动插件对格式转换文件的运行代码进行调用，运行格式转换文件的配置参数，从而获取格式转换文件关联的文档调取路径，在文档调取路径指示的位置提取目标文档。具体地，启动插件可为Swagger2Markup(文档书写框架2标记语言)插件，引入Swagger2Markup插件的过程可基于图2C中的代码实现，过程可以概括如下：将Swagger2Markup插件引入数据仓库中，根据Swagger2Markup插件在数据仓库中的存储位置，为Swagger2Markup插件设置在数据仓库中的GroupId、ArtifactId和Version，这样，在调用Swagger2Markup插件时，便可以按照GroupId、ArtifactId和Version在仓库中查找该Swagger2Mmarkup插件，并调用该Swagger2Markup插件。

在实际应用的过程中，由于本发明涉及的整个格式转换过程中涉及到的插件以及文件较多，因此，可以新建一个项目，该项目专门用于文档的格式转换，并在此项目中引入上述提及的启动插件以及格式转换文件，使得启动插件和格式转换文件可以在该项目中均正常的被调用以及运行。

203、基于格式转换文件，对目标文档的内容进行标记，生成目标文档的Markdown文件。

在本发明实施例中，当获取到目标文档后，便可以基于格式转换文件，生成该目标文档的Markdown文件。在实际应用的过程中，Swagger在生成文档时，是可以直接生成文档的Markdown文件的，而Markdown文件也是可以直接生成诸如Word(文字式文档)格式的文档或者PDF(便携式文档)格式的文档的，因此，本发明将Markdown文件作为一个中转，先生成Markdown文件，随后在将Markdown文件转换为Word格式的文档或者PDF格式的文档，从而实现目标文档与Word格式的文档或者PDF格式的文档之间的格式转换。其中，Markdown文件是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式，在生成目标文档的Markdown文件时，参见下述步骤2031至步骤2032所示的过程。

2031、对目标文档进行内容描述，生成目标文档的描述文件。

在本发明实施例中，为了实现后续对目标文档中的内容进行标记，需要先生成目标文档的描述文件，描述文件通常包括目标文档的文档标题字段、入参接口字段、出参接口字段、文档类型字段、描述内容字段。在生成目标文档的描述文件时，首先，读取目标文档包括的全部代码字段的功能，将全部代码字段中相邻且功能相同的代码字段划分为一组，得到多个代码字段组。随后，分别对多个代码字段组进行运行功能的描述，得到多个代码字段组的多个描述字段，将多个描述字段打包，生成描述文件。例如，目标文档中在表示入参接口时通常使用为一段代码，这样，可将这段代码描述为“入参接口字段”，将该“入参接口字段”作为描述文件中的一部分内容。

在实际应用的过程中，考虑到同一个项目中文档生成的描述文件包括内容的项目都是固定的，因此，可以为每个项目设置一个提取规则，按照提取规则指示的项目依次进行字段的提取，进而生成描述文件，从而避免对目标文档进行划分浪费大量的时间，也无需一一对每个代码字段组进行解析，只要按照提取规则指示的项目分别提取即可。本发明对生成描述文件的方式不进行具体限定。

2032、根据描述文件的在目标文档中指示的内容，将描述文件标注在目标文档上，生成Markdown文件。

在本发明实施例中，当生成了描述文件后，将描述文件标注在目标文档上，形成包括标记性语言的文档，也即生成Markdown文件。继续以步骤2031中的例子为例，在生成了“入参接口字段”后，将该“入参接口字段”标注在表示入参接口的一段代码上，从而形成标记性语言，以便后续生成Markdown文件。需要说明的是，为了使生成的Markdown文件更加全面完成，在将描述文件标注在目标文档上时，还可以在各段代码上标注代码的运行过程，从而使生成的Markdown文件更加清晰明朗。

在实际应用的过程中，考虑到同一时间可能会生成大量的不同目标文档的不同Markdown文件，而终端处理Markdown文件的能力是有限的，因此，还可以设置一个缓存仓库，将生成的Markdown文件均暂时存储在缓存仓库中，并为Markdown文件设置在缓存仓库中的存储路径，并在后续需要获取Markdown文件时，可以按照存储路径在缓存仓库中提取。需要说明的是，当Markdown文件从缓存仓库中被提取过后，缓存仓库便可将该Markdown文件从缓存仓库中清理，或者为缓存仓库设置清理周期，每隔清理周期，便对缓存仓库进行一次的文件清理操作，保证缓存仓库中留有足够的存储空间。

需要说明的是，上述步骤2031至步骤2032中所示的过程可以基于图2D中所示的代码运行实现。

204、引入格式转换工具，按照格式转换工具的运行要求，为格式转换工具设置环境变量。

在本发明实施例中，由于Markdown文件与Word格式或PDF格式的文档之间是可以直接进行转换的，为了实现对Markdown文件进行格式的转换，需要引入用于将Markdown文件转换为Word格式或PDF格式的格式转换工具，并在后续基于该格式转换工具实现对Markdown文件的格式转换。其中，由于不同的工具在运行时会使用不同的数据，例如指定文件夹、指定路径等，这些支持工具运行的数据组成了工具的环境变量，需要在工具运行前提前为工具配置好，因此，为了保证格式转换工具能够正常运行，在引入格式转换工具时，需要按照格式转换工具的运行要求，为格式转换工具设置环境变量，从而保证格式转换工具的正常运行。需要说明的是，在获取格式转换工具的环境变量时，可以获取格式转换工具在历史过程中成功运行时的运行日志，在运行日志中提取文件夹、路径等数据，并将这些数据打包生成该格式转换工具的环境变量，本发明对获取并设置环境变量的方式不进行具体限定。

205、接收用户的格式转换指令，在格式转换指令中提取指定转换格式，在环境变量中启动格式转换工具，调用格式转换工具，将Markdown文件转换为指定转换格式的指定文档。

在本发明实施例中，当生成了Markdown文件后，便可以接收用户的格式转换命令，按照格式转换命令的指示，调用格式转换工具，从而将Markdown文件转换为指定转换格式的指定文档。需要说明的是，指定转换格式至少为Word格式或PDF格式中的任一种，用户的格式转换指令中需要携带指定转换格式。如果格式转换指令中携带的指定转换格式为word格式的，则在调用转换工具时，控制转换工具将Markdown文件转换为word格式的指定文档。如果格式转换指令中携带的指定转换格式为PDF格式的，则在调用转换工具时，控制转换工具将Markdown文件转换为PDF格式的指定文档。

在实际应用的过程中，本发明所示的格式转换过程可以概括如下：

参见图2E，编写格式转换文件，并执行格式转换文件，在格式转换文件对应的文档调取路径中获取目标文档，生成Markdown文件。当接收到格式转换命令时，如果格式转换命令指示转换为word格式的文档，则基于转换工具将Markdown文件转换为word格式的文档。如果格式转换命令指示转换为PDF格式的文档，则基于转换工具将Markdown文件转换为PDF格式的文档。

本发明实施例提供的方法，可以通过运行格式转换文件，在格式转换文件对应的文档调取路径中获取目标文档，并基于格式转换文件，对目标文档的内容进行标记，生成目标文档的标记语言Markdown文件，进而对Markdown文件进行格式转换，生成指定转换格式的指定文档，使得可以直接输出Word格式或者PDF格式的文档，无需再执行其他的格式转换操作，提高了生成的文档的兼容性，降低了团队之间的沟通成本。

进一步地，作为图1所述方法的具体实现，本发明实施例提供了一种文档格式转换装置，如图3A所示，所述装置包括：运行模块301，第一生成模块302和转换模块303。

该运行模块301，用于运行格式转换文件，在所述格式转换文件对应的文档调取路径中获取目标文档，所述格式转换文件至少包括对所述目标文档的内容进行标记的配置参数；

该第一生成模块302，用于基于所述格式转换文件，对所述目标文档的内容进行标记，生成所述目标文档的Markdown文件；

该转换模块303，用于确定用户的指定转换格式，对所述Markdown文件进行格式转换，生成所述指定转换格式的指定文档。

在具体的应用场景中，如图3B所示，该装置还包括：获取模块304，第二生成模块305和关联模块306。

该获取模块304，用于获取当前项目的配置文件，在所述配置文件中设置用于对文档中内容进行标记的所述配置参数，生成初始文件，所述配置参数至少为Swagger的参数；

该第二生成模块305，用于在所述初始文件中添加所述配置参数的运行代码，生成所述格式转换文件；

该关联模块306，用于确定所述当前项目对应的所述文档调取路径，将所述文档调取路径与所述格式转换文件进行关联。

在具体的应用场景中，如图3C所示，该运行模块301，包括：调用单元3011和提取单元3012。

该调用单元3011，用于在数据仓库中引入启动插件，基于所述启动插件对所述格式转换文件的运行代码进行调用，运行所述格式转换文件的配置参数；

该提取单元3012，用于获取所述格式转换文件关联的所述文档调取路径，在所述文档调取路径指示的位置提取所述目标文档。

在具体的应用场景中，如图3D所示，该第一生成模块302，包括：描述单元3021和标注单元3022。

该描述单元3021，用于对所述目标文档进行内容描述，生成所述目标文档的描述文件，所述描述文件至少包括所述目标文档的文档标题字段、入参接口字段、出参接口字段、文档类型字段或描述内容字段；

该标注单元3022，用于根据所述描述文件的在所述目标文档中指示的内容，将所述描述文件标注在所述目标文档上，生成所述Markdown文件。

在具体的应用场景中，该描述单元3021，用于读取所述目标文档包括的全部代码字段的功能，将所述全部代码字段中相邻且功能相同的代码字段划分为一组，得到多个代码字段组；分别对所述多个代码字段组进行运行功能的描述，得到所述多个代码字段组的多个描述字段；将所述多个描述字段打包，生成所述描述文件。

在具体的应用场景中，如图3E所示，该装置还包括：引入模块307和设置模块308。

该引入模块307，用于引入格式转换工具，所述格式转换工具用于将所述Markdown文件转换为Word格式或PDF格式；

该设置模块308，用于按照所述格式转换工具的运行要求，为所述格式转换工具设置环境变量。

在具体的应用场景中，该转换模块303，用于接收所述用户的格式转换指令，在所述格式转换指令中提取所述指定转换格式，所述指定转换格式至少为所述Word格式或所述PDF格式中的任一种；在所述环境变量中启动所述格式转换工具；调用所述格式转换工具，将所述Markdown文件转换为所述指定转换格式的指定文档。

本发明实施例提供的装置，可以通过运行格式转换文件，在格式转换文件对应的文档调取路径中获取目标文档，并基于格式转换文件，对目标文档的内容进行标记，生成目标文档的Markdown文件，进而对Markdown文件进行格式转换，生成指定转换格式的指定文档，使得可以直接输出Word格式或者PDF格式的文档，无需再执行其他的格式转换操作，提高了生成的文档的兼容性，降低了团队之间的沟通成本。

需要说明的是，本发明实施例提供的一种文档格式转换装置所涉及各功能单元的其他相应描述，可以参考图1和图2A至图2E中的对应描述，在此不再赘述。

在示例性实施例中，参见图4，还提供了一种设备，该设备400包括通信总线、处理器、存储器和通信接口，还可以包括、输入输出接口和显示设备，其中，各个功能单元之间可以通过总线完成相互间的通信。该存储器存储有计算机程序，处理器，用于执行存储器上所存放的程序，执行上述实施例中的文档格式转换方法。

一种计算机可读存储介质，其上存储有计算机程序，所述计算机程序被处理器执行时实现所述的文档格式转换方法的步骤。

通过以上的实施方式的描述，本领域的技术人员可以清楚地了解到本申请可以通过硬件实现，也可以借助软件加必要的通用硬件平台的方式来实现。基于这样的理解，本申请的技术方案可以以软件产品的形式体现出来，该软件产品可以存储在一个非易失性存储介质(可以是CD-ROM，U盘，移动硬盘等)中，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行本申请各个实施场景所述的方法。

本领域技术人员可以理解附图只是一个优选实施场景的示意图，附图中的模块或流程并不一定是实施本申请所必须的。

本领域技术人员可以理解实施场景中的装置中的模块可以按照实施场景描述进行分布于实施场景的装置中，也可以进行相应变化位于不同于本实施场景的一个或多个装置中。上述实施场景的模块可以合并为一个模块，也可以进一步拆分成多个子模块。

上述本申请序号仅仅为了描述，不代表实施场景的优劣。

以上公开的仅为本申请的几个具体实施场景，但是，本申请并非局限于此，任何本领域的技术人员能思之的变化都应落入本申请的保护范围。

Claims (10)

1.一种文档格式转换方法，其特征在于，包括：

运行格式转换文件，在所述格式转换文件对应的文档调取路径中获取目标文档，所述格式转换文件至少包括对所述目标文档的内容进行标记的配置参数；

基于所述格式转换文件，对所述目标文档的内容进行标记，生成所述目标文档的标记语言Markdown文件；

确定用户的指定转换格式，对所述Markdown文件进行格式转换，生成所述指定转换格式的指定文档。

2.根据权利要求1所述的方法，其特征在于，所述运行格式转换文件，在所述格式转换文件对应的文档调取路径中获取目标文档之前，所述方法还包括：

获取当前项目的配置文件，在所述配置文件中设置用于对文档中内容进行标记的所述配置参数，生成初始文件，所述配置参数至少为文档书写框架Swagger的参数；

在所述初始文件中添加所述配置参数的运行代码，生成所述格式转换文件；

确定所述当前项目对应的所述文档调取路径，将所述文档调取路径与所述格式转换文件进行关联。

3.根据权利要求1所述的方法，其特征在于，所述运行格式转换文件，在所述格式转换文件对应的文档调取路径中获取目标文档，包括：

在数据仓库中引入启动插件，基于所述启动插件对所述格式转换文件的运行代码进行调用，运行所述格式转换文件的配置参数；

获取所述格式转换文件关联的所述文档调取路径，在所述文档调取路径指示的位置提取所述目标文档。

4.根据权利要求1所述的方法，其特征在于，所述基于所述格式转换文件，对所述目标文档的内容进行标记，生成所述目标文档的Markdown文件，包括：

对所述目标文档进行内容描述，生成所述目标文档的描述文件，所述描述文件至少包括所述目标文档的文档标题字段、入参接口字段、出参接口字段、文档类型字段或描述内容字段；

根据所述描述文件的在所述目标文档中指示的内容，将所述描述文件标注在所述目标文档上，生成所述Markdown文件。

5.根据权利要求4所述的方法，其特征在于，所述对所述目标文档进行内容描述，生成所述目标文档的描述文件，包括：

读取所述目标文档包括的全部代码字段的功能，将所述全部代码字段中相邻且功能相同的代码字段划分为一组，得到多个代码字段组；

分别对所述多个代码字段组进行运行功能的描述，得到所述多个代码字段组的多个描述字段；

将所述多个描述字段打包，生成所述描述文件。

6.根据权利要求1所述的方法，其特征在于，所述确定用户的指定转换格式，对所述Markdown文件进行格式转换，生成所述指定转换格式的指定文档之前，所述方法还包括：

引入格式转换工具，所述格式转换工具用于将所述Markdown文件转换为文字式文档Word格式或便携式文档PDF格式；

按照所述格式转换工具的运行要求，为所述格式转换工具设置环境变量。

7.根据权利要求6所述的方法，其特征在于，所述确定用户的指定转换格式，对所述Markdown文件进行格式转换，生成所述指定转换格式的指定文档，包括：

接收所述用户的格式转换指令，在所述格式转换指令中提取所述指定转换格式，所述指定转换格式至少为所述Word格式或所述PDF格式中的任一种；

在所述环境变量中启动所述格式转换工具；

调用所述格式转换工具，将所述Markdown文件转换为所述指定转换格式的指定文档。

8.一种文档格式转换装置，其特征在于，包括：

运行模块，用于运行格式转换文件，在所述格式转换文件对应的文档调取路径中获取目标文档，所述格式转换文件至少包括对所述目标文档的内容进行标记的配置参数；

第一生成模块，用于基于所述格式转换文件，对所述目标文档的内容进行标记，生成所述目标文档的Markdown文件；

转换模块，用于确定用户的指定转换格式，对所述Markdown文件进行格式转换，生成所述指定转换格式的指定文档。

9.一种设备，包括存储器和处理器，所述存储器存储有计算机程序，其特征在于，所述处理器执行所述计算机程序时实现权利要求1至7中任一项所述方法的步骤。

10.一种可读存储介质，其上存储有计算机程序，其特征在于，所述计算机程序被处理器执行时实现权利要求1至7中任一项所述的方法的步骤。

Images