CN111414194B - 一种接口信息生成方法、系统、电子设备及存储介质 - Google Patents

Abstract

本申请公开了一种接口信息生成方法，所述接口信息生成方法包括获取目标项目程序的启动类，并为所述启动类添加注解；启动添加有所述注解的目标项目程序，并根据所述注解确定所述目标项目程序的接口类；记录所述目标项目程序启动过程中所述接口类的接口信息。本申请能够自动化生成接口信息，提高接口信息的维护效率。本申请还公开了一种接口信息生成系统、一种存储介质及一种电子设备，具有以上有益效果。

Description

一种接口信息生成方法、系统、电子设备及存储介质

技术领域

本申请涉及计算机技术领域，特别涉及一种接口信息生成方法、系统、一种电子设备及一种存储介质。

背景技术

目前在接口开发过程中不仅要完整的开发接口功能，同时还要提供完善的接口信息。在传统的接口管理过程中，需要开发人员大量的时间依据接口规范来编辑接口及维护接口文档工作。即：在开发人员编写程序后需要手动去接口平台维护相关新增或变动的接口信息，当代码接口被开发人员变更后，仍需要手动去接口平台再次维护接口信息，这种接口信息维护方法极大的耗费了开发人员的开发时间及效率。

因此，如何自动化生成接口信息，提高接口信息的维护效率是本领域技术人员目前需要解决的技术问题。

发明内容

本申请的目的是提供一种接口信息生成方法、系统、一种存储介质及一种电子设备，能够自动化生成接口信息，提高接口信息的维护效率。

为解决上述技术问题，本申请提供一种接口信息生成方法，该接口信息生成方法包括：

获取目标项目程序的启动类，并为所述启动类添加注解；

启动添加有所述注解的目标项目程序，并根据所述注解确定所述目标项目程序的接口类；

记录所述目标项目程序启动过程中所述接口类的接口信息。

可选的，在记录所述目标项目程序启动过程中所述接口类的接口信息之后，还包括：

将所述接口信息上传至接口平台，以便利用所述接口平台对所述接口信息执行接口验证操作。

可选的，利用所述接口平台对所述接口信息执行接口验证操作包括：

设置所述接口平台的接口测试环境，并在所述接口测试环境下根据所述接口信息执行接口模拟请求对应的测试操作；

根据接口模拟测试结果判断所述接口信息对应的程序接口是否出参正确。

可选的，将所述接口信息上传至接口平台包括：

按照接口名称对所述接口信息进行聚类得到接口信息统计文件，并将所述接口信息统计文件上传至所述接口平台。

可选的，所述接口信息包括接口名称、接口方法、接口请求入参和接口请求出参。

可选的，为所述启动类添加注解包括：

为所述启动类添加spring注解。

可选的，根据所述注解确定所述目标项目程序的接口类包括：

利用spring框架根据所述注释记录所述目标项目程序中的所述接口类；

通过所述目标项目程序的监听事件确定所述spring框架中记录的所述接口类。

本申请还提供了一种接口信息生成系统，该系统包括：

注解添加模块，用于获取目标项目程序的启动类，并为所述启动类添加注解；

接口类确定模块，用于启动添加有所述注解的目标项目程序，并根据所述注解确定所述目标项目程序的接口类；

接口信息生成模块，用于记录所述目标项目程序启动过程中所述接口类的接口信息。

本申请还提供了一种存储介质，其上存储有计算机程序，所述计算机程序执行时实现上述接口信息生成方法执行的步骤。

本申请还提供了一种电子设备，包括存储器和处理器，所述存储器中存储有计算机程序，所述处理器调用所述存储器中的计算机程序时实现上述接口信息生成方法执行的步骤。

本申请提供了一种接口信息生成方法，包括获取目标项目程序的启动类，并为所述启动类添加注解；启动添加有所述注解的目标项目程序，并根据所述注解确定所述目标项目程序的接口类；记录所述目标项目程序启动过程中所述接口类的接口信息。

本申请先获取目标项目程序的启动类，在启动类中添加注解以便为启动类对应的代码提供元数据支持。在启动添加有注解的目标项目程序后能够根据注解确定目标项目程序中的接口类，进而可以自动记录所述目标项目程序启动过程中各个接口类的接口信息。本申请通过为代码中的启动类添加注解自动整合接口类的接口信息，无需手动维护接口信息，因此本申请能够自动化生成接口信息，提高接口信息的维护效率。本申请同时还提供了一种接口信息生成系统、一种存储介质和一种电子设备，具有上述有益效果，在此不再赘述。

附图说明

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

图1为本申请实施例所提供的一种接口信息生成方法的流程图；

图2为本申请实施例所提供的一种启动程序自动生成接口信息的原理示意图；

图3为本申请实施例所提供的一种接口信息生成系统的结构示意图。

具体实施方式

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

下面请参见图1，图1为本申请实施例所提供的一种接口信息生成方法的流程图。

具体步骤可以包括：

S101：获取目标项目程序的启动类，并为所述启动类添加注解；

其中，在本步骤之前可以存在接收到接口信息生成指令的操作，根据接口信息指令获取目标项目程序的启动类，本实施例不限定目标项目程序的数量，本实施例可以对任意数量个目标项目程序的启动类进行获取操作。类是代码中用户定义的引用数据类型，也称类类型。每个类包含数据说明和一组操作数据或传递消息的函数。本步骤中所提到的启动类是负责整个目标项目程序启动的一个类。注解用于为目标项目程序(如Java代码)提供元数据。作为元数据，注解可以不直接影响代码执行。

具体的，在本实施例中可以获取目标项目程序中启动类在目标项目程序对应的代码中的位置信息，根据该位置信息为启动类添加对应的注解。

S102：启动添加有所述注解的目标项目程序，并根据所述注解确定所述目标项目程序的接口类；

其中，本步骤建立在已经为启动类添加注解的基础上，启动添加有注解的目标项目程序，在目标项目程序启动的过程中本实施例可以根据之前添加的主机而确定目标项目程序的接口类。作为一种可行的实施方式，本实施例可以利用容器框架根据注解扫描得到目标项目程序中的接口类。

S103：记录所述目标项目程序启动过程中所述接口类的接口信息。

其中，在得到目标项目程序中的接口类的基础上，本实施例可以记录目标项目程序启动过程中各个接口类的接口信息。具体的，本实施例中所提到的接口信息可以包括接口名称、接口方法、接口请求入参和接口请求出参。其中，接口请求入参指接口的请求参数，接口请求出参指接口的返回结果。

本实施例先获取目标项目程序的启动类，在启动类中添加注解以便为启动类对应的代码提供元数据支持。在启动添加有注解的目标项目程序后能够根据注解确定目标项目程序中的接口类，进而可以自动记录所述目标项目程序启动过程中各个接口类的接口信息。本实施例通过为代码中的启动类添加注解自动整合接口类的接口信息，无需手动维护接口信息，因此本实施例能够自动化生成接口信息，提高接口信息的维护效率。

作为对于图1对应实施例的进一步介绍，在记录了目标项目程序启动过程中所述接口类的接口信息之后，还可以将所述接口信息上传至接口平台，以便利用所述接口平台对所述接口信息执行接口验证操作。

具体的，利用所述接口平台对所述接口信息执行接口验证操作可以具体包括以下过程：设置所述接口平台的接口测试环境，并在所述接口测试环境下根据所述接口信息执行接口模拟请求对应的测试操作；根据接口模拟测试结果判断所述接口信息对应的程序接口是否出参正确。如果程序接口出参错误，则可以生成相应的提示信息，以便告知工作人员对目标项目程序的代码进行维护。

具体的，在将所述接口信息上传至接口平台的过程中，本实施例还可以按照接口名称对所述接口信息进行聚类得到接口信息统计文件，并将所述接口信息统计文件上传至所述接口平台。

作为对于图1对应实施例的进一步介绍，为所述启动类添加注解的方式可以包括：为所述启动类添加spring注解。相应的，若图1对应的实施例为启动类添加spring注解，则可以利用spring框架根据所述注释记录所述目标项目程序中的所述接口类；通过所述目标项目程序的监听事件确定所述spring框架中记录的所述接口类。

下面通过在实际应用中的实施例说明上述实施例描述的流程，请参见图2，图2为本申请实施例所提供的一种启动程序自动生成接口信息的原理示意图，根据图2可以看出，本实施例先在程序启动类中添加注解，启动程序使监听事件生效扫描所有程序内接口并在启动程序后记录所有接口结果，自动生成所有接口信息，进而将自动生成的接口信息会自动整合到接口平台上。本实施例在代码中新增接口或者变动接口后不需要人工介入，可以自动生成最新的接口信息到接口平台，开发或测试人员可以在接口平台上随意模拟请求接口并验证接口结果。本实施例的具体过程如下：

步骤1、代码添加注解；

每个项目程序都可以有启动类，在程序的启动类下添加spring注解，主要是将整个程序包都添加进注解，以便spring可以扫描整个程序中所有的接口类。

步骤2、项目程序启动；

在项目启动后会触发开发人员编写的监听事件，监听事件的目的是扫描所有记录在spring中的接口，记录接口的接口方法、接口请求入参、接口请求出参等结果，使其生成一串树结构的数据。

步骤3、接口信息记录；

程序启动后就会自动生成接口，将代码中所写接口的名称、接口的方式、接口的请求入参以及接口的请求返回信息全部自动生成，完成接口信息内容的整理。出于step2的数据，会在接口平台上展示这些被记录的接口结果。

步骤4、接口信息验证；

接口平台接收到自动生成的接口信息将其整合在平台上，接口平台是提供开发或测试人员调试或测试各接口信息的地方。接口平台上整合了所有接口名称、接口方法、接口请求入参、接口请求出参，另外开发或测试人员可以在接口平台上自主选择接口想要访问的环境，通过不同的接口请求入参来完成各种接口请求，验证接口请求出参的正确性。

本实施例通过代码注解自动整合接口请求方式、接口请求入参及接口请求返回信息，通过启动程序自动更新所有接口信息，通过接口整合平台随意切换接口访问环境，通过接口整合平台随意模拟接口请求及验证接口返回信息。

采用故本实施例的实施方案，在代码中新增接口或者变动接口后无需人工介入，可以自动生成最新的接口信息到接口平台，开发或测试人员可以在接口平台上随意模拟请求接口并验证接口结果，进而提高接口测试的效率。

例如：目前方案平均m个开发人员维护n个接口的时间大约是3n*5分钟，而本方案维护接口的时间大约是n*1分钟。

按照目前经验，举例如下：

目前方案平均m个开发人员所有需要投入时间为3*n*5分钟，共计投入时间为3*m*n*5，假设m＝2，n＝10，共计需要投入时间300分钟。

本方案无需多个开发人员投入接口维护，只需启动项目程序即可自动维护更新接口信息，假设接口更新至接口平台有网络延迟等原因，预计1分钟，维护n个接口时间大约为n*1分钟，平均m个开发人员模拟请求接口时间大约为1分钟，共计投入时间为n*1+m*n*1，假设m＝2，n＝10，共计投入时间30分钟。目前方案与本方案对比而言，目前方案需要300分钟，本方案只需30分钟，(300-30)/300，提高效率90％。

目前方案m个开发人员投入接口维护时间为2*m*n*5分钟，本发明方案只需开发人员投入时间为n*1分钟，假设m＝2，n＝10，本方案在维护接口阶段提升了95％的效率。目前方案平均m个开发、前端、测试人员借助第三方工具模拟接口请求需要m*n*5分钟，本发明方案只需平均m个相关人员在接口平台上直接发起模拟接口请求，大约只需m*n*1分钟，假设m＝2，n＝10，本方案在接口模拟请求阶段提升了80％的效率。结合以上两个阶段的总体情况，整个过程中目前方案维护接口及模拟请求接口在平均m个开发人员时投入时间为3*m*n*5分钟，本方案在整个过程中平均m个开发人员投入时间为n*1+m*n*1分钟，假设m＝2，n＝10，本方案在接口的整个维护及模拟请求过程中提升了90％的效率。目前方案前端人员在接口调试时需要经常去询问开发人员是否有变更接口信息是否已维护接口信息，一个项目预计需要累计的沟通时间10小时，本发明方案接口会自动实时更新，不存在接口信息不正确的情况，避免了因为接口问题而频繁跟开发同学的沟通确认工作，节省了原方案需要的累计沟通10小时的时间。

由此可见，以往在开发过程中需要投入大量的开发人员实时维护接口信息，每次代码变更需要人力实时维护，耗时耗力。而使用本实施例可以节省大量的人力和时间投入。在传统方案中接口内容不会实时更新，每次查看不能保证接口信息是否是最新的，严重影响前端对接工作的有效性。而使用本实施例可以随之代码更新可以实时更新接口内容信息，保证前端对接的接口都是有效且正确的。在传统方案中测试人员无法实时模拟接口请求情况，验证接口是否正确。而使用本实施例可以实时更新接口内容信息在整合平台，测试人员可以随时模拟接口请求，验证接口的正确性。在传统方案中开发人员与测试人员无法方便的完成接口在各个环境的测试，需要借助第三方工具来完成各个环境的接口测试工作。而使用本实施例可以实时更新接口内容在整合平台，帮助开发及测试人员实时选择不同的环境来完成接口的测试，极大了节省了时间成本。

请参见图3，图3为本申请实施例所提供的一种接口信息生成系统的结构示意图；

该系统可以包括：

注解添加模块100，用于获取目标项目程序的启动类，并为所述启动类添加注解；

接口类确定模块200，用于启动添加有所述注解的目标项目程序，并根据所述注解确定所述目标项目程序的接口类；

接口信息生成模块300，用于记录所述目标项目程序启动过程中所述接口类的接口信息。

本实施例先获取目标项目程序的启动类，在启动类中添加注解以便为启动类对应的代码提供元数据支持。在启动添加有注解的目标项目程序后能够根据注解确定目标项目程序中的接口类，进而可以自动记录所述目标项目程序启动过程中各个接口类的接口信息。本实施例通过为代码中的启动类添加注解自动整合接口类的接口信息，无需手动维护接口信息，因此本实施例能够自动化生成接口信息，提高接口信息的维护效率。

进一步的，还包括：

信息上传模块，用于将所述接口信息上传至接口平台，以便利用所述接口平台对所述接口信息执行接口验证操作。

进一步的，还包括：

验证模块，用于设置所述接口平台的接口测试环境，并在所述接口测试环境下根据所述接口信息执行接口模拟请求对应的测试操作；还用于根据接口模拟测试结果判断所述接口信息对应的程序接口是否出参正确。

进一步的，信息上传模块具体为用于按照接口名称对所述接口信息进行聚类得到接口信息统计文件，并将所述接口信息统计文件上传至所述接口平台的模块。

进一步的，所述接口信息包括接口名称、接口方法、接口请求入参和接口请求出参。

进一步的，注解添加模块100具体为用于为所述启动类添加spring注解的模块。

进一步的，接口类确定模块200用于利用spring框架根据所述注释记录所述目标项目程序中的所述接口类；还用于通过所述目标项目程序的监听事件确定所述spring框架中记录的所述接口类。

由于系统部分的实施例与方法部分的实施例相互对应，因此系统部分的实施例请参见方法部分的实施例的描述，这里暂不赘述。

本申请还提供了一种存储介质，其上存有计算机程序，该计算机程序被执行时可以实现上述实施例所提供的步骤。该存储介质可以包括：U盘、移动硬盘、只读存储器(Read-Only Memory，ROM)、随机存取存储器(Random Access Memory，RAM)、磁碟或者光盘等各种可以存储程序代码的介质。

本申请还提供了一种电子设备，可以包括存储器和处理器，所述存储器中存有计算机程序，所述处理器调用所述存储器中的计算机程序时，可以实现上述实施例所提供的步骤。当然所述电子设备还可以包括各种网络接口，电源等组件。

说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其他实施例的不同之处，各个实施例之间相同相似部分互相参见即可。对于实施例公开的系统而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。应当指出，对于本技术领域的普通技术人员来说，在不脱离本申请原理的前提下，还可以对本申请进行若干改进和修饰，这些改进和修饰也落入本申请权利要求的保护范围内。

还需要说明的是，在本说明书中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的状况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。

Claims (10)

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

获取目标项目程序的启动类，并为所述启动类添加注解；其中，所述启动类是负责所述目标项目程序启动的一个类，所述注解用于为所述目标项目程序提供元数据；

启动添加有所述注解的目标项目程序，并根据所述注解确定所述目标项目程序的接口类；

记录所述目标项目程序启动过程中所述接口类的接口信息。

2.根据权利要求1所述接口信息生成方法，其特征在于，在记录所述目标项目程序启动过程中所述接口类的接口信息之后，还包括：

将所述接口信息上传至接口平台，以便利用所述接口平台对所述接口信息执行接口验证操作。

3.根据权利要求2所述接口信息生成方法，其特征在于，利用所述接口平台对所述接口信息执行接口验证操作包括：

设置所述接口平台的接口测试环境，并在所述接口测试环境下根据所述接口信息执行接口模拟请求对应的测试操作；

根据接口模拟测试结果判断所述接口信息对应的程序接口是否出参正确。

4.根据权利要求2所述接口信息生成方法，其特征在于，将所述接口信息上传至接口平台包括：

按照接口名称对所述接口信息进行聚类得到接口信息统计文件，并将所述接口信息统计文件上传至所述接口平台。

5.根据权利要求1所述接口信息生成方法，其特征在于，所述接口信息包括接口名称、接口方法、接口请求入参和接口请求出参。

6.根据权利要求1所述接口信息生成方法，其特征在于，为所述启动类添加注解包括：

为所述启动类添加spring注解。

7.根据权利要求6所述接口信息生成方法，其特征在于，根据所述注解确定所述目标项目程序的接口类包括：

利用spring框架根据所述注解记录所述目标项目程序中的所述接口类；

通过所述目标项目程序的监听事件确定所述spring框架中记录的所述接口类。

8.一种接口信息生成系统，其特征在于，包括：

注解添加模块，用于获取目标项目程序的启动类，并为所述启动类添加注解；其中，所述启动类是负责所述目标项目程序启动的一个类，所述注解用于为所述目标项目程序提供元数据；

接口类确定模块，用于启动添加有所述注解的目标项目程序，并根据所述注解确定所述目标项目程序的接口类；

接口信息生成模块，用于记录所述目标项目程序启动过程中所述接口类的接口信息。

9.一种电子设备，其特征在于，包括存储器和处理器，所述存储器中存储有计算机程序，所述处理器调用所述存储器中的计算机程序时实现如权利要求1至7任一项所述接口信息生成方法的步骤。

10.一种存储介质，其特征在于，所述存储介质中存储有计算机可执行指令，所述计算机可执行指令被处理器加载并执行时，实现如上权利要求1至7任一项所述接口信息生成方法的步骤。