基于接口文档的代码生成方法、装置、存储介质及服务器

摘要

本发明公开了一种基于接口文档的代码生成方法、装置、存储介质及服务器；其中，所述方法包括：在软件项目中配置接口文档代码生成插件，所述接口文档代码生成插件为maven插件；配置接口文档的路径配置文件，所述路径配置文件用于指示接口文档地址；利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，得到所述接口文档的接口文档地址；利用所述接口文档代码生成插件根据所述接口文档地址确定所述接口文档并获取所述接口文档的内容，根据所述接口文档的内容生成接口代码。上述方法能够自动化根据接口文档生成接口代码，无需人工手动操作，可降低接口代码的出错概率，并可提升接口代码的生成效率。

说明书

技术领域

本发明涉及接口数据处理技术领域，尤其涉及一种基于接口文档的代码生成方法、装置、存储介质及服务器。

背景技术

目前一个开发项目版本的迭代流程如图1所示。产品经理组织前后端及测试等人员开会讨论需求，在会议过程中确定需求的范围及涉及到相关业务。后端开发人员梳理好业务逻辑之后编写接口文档，后端开发者根据接口文档手动编写最原始的接口代码。前端同时根据接口文档编写前端代码。前后端完成各自的开发工作以后进行代码的联调工作。前后端联调成功之后提交给测试人员进行系统的测试，测试人员测试通过发布测试报告进行生产环境的上线。

当前人工生成接口代码的方式存在以下问题：

1、整个过程都需要开发人员手动操作，加大了出错的概率。

2、在将接口文档转换成为接口代码的过程中存在大量的重复代码，全部都有开发者手动写费时费力，降低了效率。

发明内容

本发明的目的在于克服现有技术的不足，本发明提供了一种基于接口文档的代码生成方法、装置、存储介质及服务器，可自动化根据接口文档生成接口代码，无需人工手动操作，可降低接口代码的出错概率，并可提升接口代码的生成效率。

为了解决上述技术问题，本发明实施例提供了一种基于接口文档的代码生成方法，所述方法包括：

在软件项目中配置接口文档代码生成插件，所述接口文档代码生成插件为maven插件；

配置接口文档的路径配置文件，所述路径配置文件用于指示接口文档地址；

利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，得到所述接口文档的接口文档地址；

利用所述接口文档代码生成插件根据所述接口文档地址确定所述接口文档并获取所述接口文档的内容，根据所述接口文档的内容生成接口代码。

可选的，所述接口文档的内容包括接口名称、修饰符号、参数内容、注释内容。

可选的，所述根据所述接口文档的内容生成接口代码，包括：

确定所述接口代码的格式布局以及所述接口代码的生成文档；

根据所述格式布局获取所述接口名称对应在所述生成文档中的第一位置，根据所述接口名称在所述第一位置生成所述接口名称的代码；

根据所述格式布局获取所述修饰符号对应在所述生成文档中的第二位置，根据所述修饰符号在所述第二位置生成所述修饰符号的代码；

根据所述格式布局获取所述参数内容对应在所述生成文档中的第三位置，根据所述参数内容在所述第三位置生成所述参数内容的代码；

根据所述格式布局获取所述注释内容对应在所述生成文档中的第四位置，根据所述注释内容在所述第四位置生成所述注释内容的代码；

根据所述接口名称的代码、所述修饰符号的代码、所述参数内容的代码以及所述注释内容的代码得到所述接口代码。

可选的，所述方法还包括：

确定maven项目对象模型中所述软件项目的每个构建步骤；

根据所述每个构建步骤生成所述接口文档代码生成插件。

可选的，所述接口文档代码生成插件为聚合的Java类文件、相关的元数据、文本、图片的Jar数据包，并且所述接口文档代码生成插件用于实现maven插件的接口。

可选的，所述利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，包括：

在pom文件的build标签里引用所述接口文档代码生成插件，以利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件。

可选的，所述根据所述接口文档的内容生成接口代码之后，还包括：

运行所述接口代码，得到所述接口代码的运行结果；

根据所述运行结果确定所述接口代码中的错误代码；

根据所述错误代码确定所述接口文档中的错误内容；

根据所述错误内容修改所述接口文档。

另外，本发明实施例还提供了一种基于接口文档的代码生成装置，所述装置包括：

第一配置模块：用于在软件项目中配置接口文档代码生成插件，所述接口文档代码生成插件为maven插件；

第二配置模块：用于配置接口文档的路径配置文件，所述路径配置文件用于指示接口文档地址；

解析模块：用于利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，得到所述接口文档的接口文档地址；

生成模块：用于利用所述接口文档代码生成插件根据所述接口文档地址确定所述接口文档并获取所述接口文档的内容，根据所述接口文档的内容生成接口代码。

另外，本发明实施例还提供了一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现上述中任意一项所述的程序批量刷单鉴别方法。

另外，本发明实施例还提供了一种服务器，其包括：

一个或多个处理器；

存储器；

一个或多个应用程序，其中所述一个或多个应用程序被存储在所述存储器中并被配置为由所述一个或多个处理器执行，所述一个或多个应用程序配置用于：执行上述中任意一项所述的程序批量刷单鉴别方法。

在本发明实施例中，通过在软件项目中配置接口文档代码生成插件，利用接口文档代码生成插件的解析器解析接口文档的路径配置文件，得到接口文档地址；进而，利用接口文档代码生成插件根据接口文档地址获取接口文档的内容，最终利用接口文档代码生成插件根据接口文档的内容生成接口代码。因此，可将原来的全手动编码变成自动生成接口代码，减少了工作量，合理有效的避免了代码生成过程中的出错率，并提升了开发人员的效率，有效的缩短了项目的迭代时间。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见的，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其它的附图。

图1是开发项目版本的迭代流程；

图2是本发明实施例中的基于接口文档的代码生成方法的流程示意图；

图3是本发明实施例中的基于接口文档的代码生成装置的结构组成示意图；

图4是本发明实施例中的服务器的结构组成示意图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其它实施例，都属于本发明保护的范围。

实施例

请参阅图2，图2是本发明实施例中的基于接口文档的代码生成方法的流程示意图。

如图2所示，一种基于接口文档的代码生成方法，包括以下步骤：

S21，在软件项目中配置接口文档代码生成插件，所述接口文档代码生成插件为maven插件。

在本实施例中，软件项目为maven项目管理工具。接口文档代码生成插件为maven插件。maven插件可以配置在maven项目管理工具中，并执行maven项目管理工具中的任务。其中，接口文档代码生成插件可以是根据对应的各类接口特性自主研发的插件。接口文档代码生成插件可以根据接口文档反向生成接口代码。

S22，配置接口文档的路径配置文件，所述路径配置文件用于指示接口文档地址。

在本实施例中，在软件项目中加载接口文档的路径配置文件。路径配置文件用于指示接口文档地址。具体地，路径配置文件中包含有一个或多个接口文档的存储的路径信息。通过路径信息能够确定出对应接口文档的地址。最终通过寻址的方式可以确定出接口文档的存储位置。

S23，利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，得到所述接口文档的接口文档地址。

在本实施例中，利用自主研发的接口文档代码生成插件中的配置解析器解析路径配置文件中的信息，即可获得接口文档的接口文档地址。具体地，路径配置文件可以包括一个或多个接口的接口文档的路径信息，因此利用接口文档代码生成插件的配置解析器解析路径配置文件得到一个或多个接口的接口文档地址。

S24，利用所述接口文档代码生成插件根据所述接口文档地址确定所述接口文档并获取所述接口文档的内容，根据所述接口文档的内容生成接口代码。

在本实施例中，利用接口文档代码生成插件读取接口文档中的内容，读取完成之后根据读取到的内容进行代码生成，以生成对应接口的接口代码。具体地，根据一个接口文档地址确定一个接口文档的内容，进而根据该接口文档的内容生成接口代码。当根据多个接口文档的多个接口文档的内容时，分别根据各接口文档的内容生成对应的接口代码。

其中，接口文档的内容包括接口名称、修饰符号、参数内容、注释内容。

进一步地，所述根据所述接口文档的内容生成接口代码，包括：确定所述接口代码的格式布局以及所述接口代码的生成文档；根据所述格式布局获取所述接口名称对应在所述生成文档中的第一位置，根据所述接口名称在所述第一位置生成所述接口名称的代码；根据所述格式布局获取所述修饰符号对应在所述生成文档中的第二位置，根据所述修饰符号在所述第二位置生成所述修饰符号的代码；根据所述格式布局获取所述参数内容对应在所述生成文档中的第三位置，根据所述参数内容在所述第三位置生成所述参数内容的代码；根据所述格式布局获取所述注释内容对应在所述生成文档中的第四位置，根据所述注释内容在所述第四位置生成所述注释内容的代码；根据所述接口名称的代码、所述修饰符号的代码、所述参数内容的代码以及所述注释内容的代码得到所述接口代码。

具体地，接口文档的内容包括接口名称、修饰符号、参数内容、注释内容。其生成的接口代码也应该包含接口名称的代码、修饰符号的代码、参数内容的代码以及注释内容的代码。通过接口代码的格式布局以及接口代码的生成文档确定各内容的位置，进而在对应的位置生成对应内容的代码，使得生成的接口代码更加符合代码格式要求，因此无需对生成的接口代码进行调整，减少人工操作，同时也可避免人工操作带来的代码错误。

上述基于接口文档的代码生成方法，通过在软件项目中配置接口文档代码生成插件，利用接口文档代码生成插件的解析器解析接口文档的路径配置文件，得到接口文档地址；进而，利用接口文档代码生成插件根据接口文档地址获取接口文档的内容，最终利用接口文档代码生成插件根据接口文档的内容生成接口代码。因此，可将原来的全手动编码变成自动生成接口代码，减少了工作量，合理有效的避免了代码生成过程中的出错率，并提升了开发人员的效率，有效的缩短了项目的迭代时间。

优选地，S21之前，所述方法还包括：确定maven项目对象模型中所述软件项目的每个构建步骤；根据所述每个构建步骤生成所述接口文档代码生成插件。

具体地，软件项目为maven项目管理工具。maven项目管理工具在运行命令时都会对应每个生命周期。每个生命周期在执行时都会确定pom.xml(Project Object Model，项目对象模型)文件中配置了哪些插件，进而运行插件。maven项目管理工具的生命周期与插件相互绑定，用以完成实际的构建任务。更具体而言，生命周期的阶段与插件的目标相互绑定，以完成某个具体的构建任务，具体的功能由插件(Plugin)实现。一个插件可以实现多个目标。为了解耦插件的功能和工程阶段以实现高度的可配置性，maven项目管理工具规定插件只是实现目标的功能，通过配置来决定在哪个阶段执行哪些目标操作。

因此，需要在maven项目管理工具配置接口文档代码生成插件之前，确定maven项目对象模型中软件项目的每个构建步骤，进而根据每个构建步骤生成接口文档代码生成插件，从而使得maven项目管理工具能够利用生成的接口文档代码生成插件执行对应的接口代码生成工作。

优选地，所述接口文档代码生成插件为聚合的Java类文件、相关的元数据、文本、图片的Jar数据包，并且所述接口文档代码生成插件用于实现maven插件的接口。

具体地，maven插件的本质为使用maven编写的一些java代码并将而java代码打包成的jar包。其中，jar包是一种软件包文件格式，通常聚合有大量的Java类文件、相关的元数据和资源。资源包括文本、图片等。

优选地，所述利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，包括：在pom文件的build标签里引用所述接口文档代码生成插件，以利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件。

具体地，在使用的时候，在pom文件的build标签里引用接口文档代码生成插件即可。插件制作完成后在配置文件中配置接口文档地址，之后在项目中运行插件，插件将根据配置信息寻找接口文档并读取接口文档中的内容并在项目中生成相应的代码。因此，可实现自动化生成接口代码。

优选地，所述根据所述接口文档的内容生成接口代码之后，还包括：运行所述接口代码，得到所述接口代码的运行结果；根据所述运行结果确定所述接口代码中的错误代码；根据所述错误代码确定所述接口文档中的错误内容；根据所述错误内容修改所述接口文档。

具体地，采用接口文档代码生成插件自动化生成接口代码之后，可以进一步运行接口代码，获取接口代码的运行结果。当运行结果中出现错误代码时，根据错误代码确定接口文档中的错误内容，最终根据错误内容修改接口文档。因此，可以通过结果反馈的方式进行自动化调试，无需人为参与即可对接口文档内容进行调整，从而提高接口文档内容的准确性。

与现有方案相比，本申请的基于接口文档的代码生成方法减少了开发人员人工开发的过程，由原来的全手动编码改为了自动生成编码，减轻了工作量，合理有效的避免了编码过程中的出错率，提升了开发人员的效率，有效的缩短了项目的迭代时间。

实施例

请参阅图3，图3是本发明实施例中的基于接口文档的代码生成装置的结构组成示意图。

一种基于接口文档的代码生成装置，所述装置包括：

第一配置模块31：用于在软件项目中配置接口文档代码生成插件，所述接口文档代码生成插件为maven插件。

在本实施例中，软件项目为maven项目管理工具。接口文档代码生成插件为maven插件。maven插件可以配置在maven项目管理工具中，并执行maven项目管理工具中的任务。其中，接口文档代码生成插件可以是根据对应的各类接口特性自主研发的插件。接口文档代码生成插件可以根据接口文档反向生成接口代码。

第二配置模块32：用于配置接口文档的路径配置文件，所述路径配置文件用于指示接口文档地址。

在本实施例中，在软件项目中加载接口文档的路径配置文件。路径配置文件用于指示接口文档地址。具体地，路径配置文件中包含有一个或多个接口文档的存储的路径信息。通过路径信息能够确定出对应接口文档的地址。最终通过寻址的方式可以确定出接口文档的存储位置。

解析模块33：用于利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，得到所述接口文档的接口文档地址。

在本实施例中，利用自主研发的接口文档代码生成插件中的配置解析器解析路径配置文件中的信息，即可获得接口文档的接口文档地址。具体地，路径配置文件可以包括一个或多个接口的接口文档的路径信息，因此利用接口文档代码生成插件的配置解析器解析路径配置文件得到一个或多个接口的接口文档地址。

生成模块34：用于利用所述接口文档代码生成插件根据所述接口文档地址确定所述接口文档并获取所述接口文档的内容，根据所述接口文档的内容生成接口代码。

在本实施例中，利用接口文档代码生成插件读取接口文档中的内容，读取完成之后根据读取到的内容进行代码生成，以生成对应接口的接口代码。具体地，根据一个接口文档地址确定一个接口文档的内容，进而根据该接口文档的内容生成接口代码。当根据多个接口文档的多个接口文档的内容时，分别根据各接口文档的内容生成对应的接口代码。

其中，接口文档的内容包括接口名称、修饰符号、参数内容、注释内容。

进一步地，所述根据所述接口文档的内容生成接口代码，包括：确定所述接口代码的格式布局以及所述接口代码的生成文档；根据所述格式布局获取所述接口名称对应在所述生成文档中的第一位置，根据所述接口名称在所述第一位置生成所述接口名称的代码；根据所述格式布局获取所述修饰符号对应在所述生成文档中的第二位置，根据所述修饰符号在所述第二位置生成所述修饰符号的代码；根据所述格式布局获取所述参数内容对应在所述生成文档中的第三位置，根据所述参数内容在所述第三位置生成所述参数内容的代码；根据所述格式布局获取所述注释内容对应在所述生成文档中的第四位置，根据所述注释内容在所述第四位置生成所述注释内容的代码；根据所述接口名称的代码、所述修饰符号的代码、所述参数内容的代码以及所述注释内容的代码得到所述接口代码。

具体地，接口文档的内容包括接口名称、修饰符号、参数内容、注释内容。其生成的接口代码也应该包含接口名称的代码、修饰符号的代码、参数内容的代码以及注释内容的代码。通过接口代码的格式布局以及接口代码的生成文档确定各内容的位置，进而在对应的位置生成对应内容的代码，使得生成的接口代码更加符合代码格式要求，因此无需对生成的接口代码进行调整，减少人工操作，同时也可避免人工操作带来的代码错误。

优选地，一种基于接口文档的代码生成装置还包括生成模块(图3未示出)，用于确定maven项目对象模型中所述软件项目的每个构建步骤；根据所述每个构建步骤生成所述接口文档代码生成插件。

具体地，软件项目为maven项目管理工具。maven项目管理工具在运行命令时都会对应每个生命周期。每个生命周期在执行时都会确定pom.xml(Project Object Model，项目对象模型)文件中配置了哪些插件，进而运行插件。maven项目管理工具的生命周期与插件相互绑定，用以完成实际的构建任务。更具体而言，生命周期的阶段与插件的目标相互绑定，以完成某个具体的构建任务，具体的功能由插件(Plugin)实现。一个插件可以实现多个目标。为了解耦插件的功能和工程阶段以实现高度的可配置性，maven项目管理工具规定插件只是实现目标的功能，通过配置来决定在哪个阶段执行哪些目标操作。

因此，需要在maven项目管理工具配置接口文档代码生成插件之前，确定maven项目对象模型中软件项目的每个构建步骤，进而根据每个构建步骤生成接口文档代码生成插件，从而使得maven项目管理工具能够利用生成的接口文档代码生成插件执行对应的接口代码生成工作。

优选地，所述接口文档代码生成插件为聚合的Java类文件、相关的元数据、文本、图片的Jar数据包，并且所述接口文档代码生成插件用于实现maven插件的接口。

具体地，maven插件的本质为使用maven编写的一些java代码并将而java代码打包成的jar包。其中，jar包是一种软件包文件格式，通常聚合有大量的Java类文件、相关的元数据和资源。资源包括文本、图片等。

优选地，解析模块33还用于在pom文件的build标签里引用所述接口文档代码生成插件，以利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件。

具体地，在使用的时候，在pom文件的build标签里引用接口文档代码生成插件即可。插件制作完成后在配置文件中配置接口文档地址，之后在项目中运行插件，插件将根据配置信息寻找接口文档并读取接口文档中的内容并在项目中生成相应的代码。因此，可实现自动化生成接口代码。

优选地，一种基于接口文档的代码生成装置还包括修改模块(图3未示出)，用于运行所述接口代码，得到所述接口代码的运行结果；根据所述运行结果确定所述接口代码中的错误代码；根据所述错误代码确定所述接口文档中的错误内容；根据所述错误内容修改所述接口文档。

具体地，采用接口文档代码生成插件自动化生成接口代码之后，可以进一步运行接口代码，获取接口代码的运行结果。当运行结果中出现错误代码时，根据错误代码确定接口文档中的错误内容，最终根据错误内容修改接口文档。因此，可以通过结果反馈的方式进行自动化调试，无需人为参与即可对接口文档内容进行调整，从而提高接口文档内容的准确性。

在本发明实施例中，通过在软件项目中配置接口文档代码生成插件，利用接口文档代码生成插件的解析器解析接口文档的路径配置文件，得到接口文档地址；进而，利用接口文档代码生成插件根据接口文档地址获取接口文档的内容，最终利用接口文档代码生成插件根据接口文档的内容生成接口代码。因此，可将原来的全手动编码变成自动生成接口代码，减少了工作量，合理有效的避免了代码生成过程中的出错率，并提升了开发人员的效率，有效的缩短了项目的迭代时间。

本发明实施例提供的一种计算机可读存储介质，所述计算机可读存储介质上存储有计算机程序，该程序被处理器执行时实现上述实施例中任意一个实施例的基于接口文档的代码生成方法。其中，所述计算机可读存储介质包括但不限于任何类型的盘(包括软盘、硬盘、光盘、CD-ROM、和磁光盘)、ROM(Read-Only Memory，只读存储器)、RAM(Random AcceSSMemory，随即存储器)、EPROM(EraSable Programmable Read-Only Memory，可擦写可编程只读存储器)、EEPROM(Electrically EraSable ProgrammableRead-Only Memory，电可擦可编程只读存储器)、闪存、磁性卡片或光线卡片。也就是，存储设备包括由设备(例如，计算机、手机)以能够读的形式存储或传输信息的任何介质，可以是只读存储器，磁盘或光盘等。

本发明实施例还提供了一种计算机应用程序，其运行在计算机上，该计算机应用程序用于执行上述中任意一个实施例的基于接口文档的代码生成方法。

此外，图4是本发明实施例中的服务器的结构组成示意图。

本发明实施例还提供了一种服务器，如图4所示。所述服务器包括处理器402、存储器403、输入单元404以及显示单元405等器件。本领域技术人员可以理解，图4示出的设备结构器件并不构成对所有设备的限定，可以包括比图示更多或更少的部件，或者组合某些部件。存储器403可用于存储应用程序401以及各功能模块，处理器402运行存储在存储器403的应用程序401，从而执行设备的各种功能应用以及数据处理。存储器可以是内存储器或外存储器，或者包括内存储器和外存储器两者。内存储器可以包括只读存储器(ROM)、可编程ROM(PROM)、电可编程ROM(EPROM)、电可擦写可编程ROM(EEPROM)、快闪存储器、或者随机存储器。外存储器可以包括硬盘、软盘、ZIP盘、U盘、磁带等。本发明所公开的存储器包括但不限于这些类型的存储器。本发明所公开的存储器只作为例子而非作为限定。

输入单元404用于接收信号的输入，以及接收用户输入的关键字。输入单元404可包括触控面板以及其它输入设备。触控面板可收集用户在其上或附近的触摸操作(比如用户使用手指、触笔等任何适合的物体或附件在触控面板上或在触控面板附近的操作)，并根据预先设定的程序驱动相应的连接装置；其它输入设备可以包括但不限于物理键盘、功能键(比如播放控制按键、开关按键等)、轨迹球、鼠标、操作杆等中的一种或多种。显示单元405可用于显示用户输入的信息或提供给用户的信息以及服务器的各种菜单。显示单元405可采用液晶显示器、有机发光二极管等形式。处理器402是服务器的控制中心，利用各种接口和线路连接整个设备的各个部分，通过运行或执行存储在存储器402内的软件程序和/或模块，以及调用存储在存储器内的数据，执行各种功能和处理数据。

作为一个实施例，所述服务器包括：一个或多个处理器402，存储器403，一个或多个应用程序401，其中所述一个或多个应用程序401被存储在存储器403中并被配置为由所述一个或多个处理器402执行，所述一个或多个应用程序401配置用于执行上述实施例中的任意一实施例中的基于接口文档的代码生成方法。

另外，以上对本发明实施例所提供的一种基于接口文档的代码生成方法、装置、存储介质及服务器进行了详细介绍，本文中应采用了具体个例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想；同时，对于本领域的一般技术人员，依据本发明的思想，在具体实施方式及应用范围上均会有改变之处，综上所述，本说明书内容不应理解为对本发明的限制。