CN110309099A - 接口管理方法、装置、设备及计算机可读存储介质 - Google Patents

Abstract

本发明涉及金融科技(Fintech)技术领域，本发明公开了一种接口管理方法，所述接口管理方法包括如下步骤：在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型；查询预设的注解对象存储数据库，获取所述接口标识对应的接口注解，并确定所述接口注解中包含的接口参数；获取所述注解对象存储数据库中各所述接口参数对应的参数注解，根据所述文档类型处理所述参数注解生成接口文档。本发明还公开了一种接口管理装置、设备和计算机可读存储介质。本发明生成了统一格式的接口文档。

Description

接口管理方法、装置、设备及计算机可读存储介质

技术领域

本发明涉及金融科技(Fintech)技术领域，尤其涉及接口管理方法、装置、设备及计算机可读存储介质。

背景技术

随着互联网技术，尤其是互联网金融科技(Fintech)的飞速发展，越来越多的技术应用在金融领域，使得传统金融业正在逐步向金融科技(Finteh)转变，接口管理技术也不例外，但由于金融行业的安全性、实时性要求，也对技术提出的更高的要求；即，当前金融业务应用程序也越来越多，当前金融业务应用程序开发之前，需要应用程序开发人员预先定义应用程序的接口文档，接口文档的编写操作较为麻烦增加了开发人员的工作量，且不同的应用程序开发人员写出来的接口文档无法统一。

发明内容

本发明的主要目的在于提出一种接口管理方法、装置、设备及计算机可读存储介质，旨在解决当前应用程序开发人员编写接口文档的操作较为麻烦，接口文档编写效率低，且编写得到的接口文档格式不统一的技术问题。

为实现上述目的，本发明提供一种接口管理方法，所述接口管理方法包括如下步骤：

在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型；

查询预设的注解对象存储数据库，获取所述接口标识对应的接口注解；

确定所述接口注解中包含的接口参数，获取所述注解对象存储数据库中各所述接口参数对应的参数注解；

根据所述文档类型处理所述参数注解生成接口文档。

可选地，所述在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型的步骤之前，包括：

在接收到接口定义请求时，输出接口定义窗口，以提示开发者输入各接口的接口注解，其中，所述接口注解包括：接口ID、接口名称和接口类型；

接收基于所述接口定义窗口输入的各接口的接口注解，获取所述接口注解中包含的接口参数，并输出参数定义窗口，以提示开发者输入各所述接口参数的参数注解，其中，所述参数注解包括：字段名、字段描述、字段类型、字段长度和是否必输入；

在检测到接口定义完成时，获取各所述接口对应的所述接口注解和所述参数注解，将所述接口注解和所述参数注解保存至预设的注解对象存储数据库。

可选地，所述根据所述文档类型处理所述参数注解生成接口文档的步骤，包括：

若所述文档类型是EXCEL类型，则将各所述参数注解组合成字符串序列，并将各所述字符串序列写入EXCEL模板中，生成EXCEL格式的接口文档；

若所述文档类型是Markdown类型，则将各所述参数注解按照Markdown的格式转化生成文本字符串，并将各所述文本字符串写入到Showdoc模板中，生成Showdoc格式的接口文档。

可选地，所述接口管理方法包括：

在接收到接口参数校验请求时，获取所述接口参数校验请求对应待校验的目标接口参数；

查询预设的注解对象存储数据库，获取所述目标接口参数对应的目标参数注解，并判断所述目标接口参数是否符合所述目标参数注解；

若所述目标接口参数符合所述目标参数注解，则输出参数校验通过；

若所述目标接口参数不符合所述目标参数注解，则输出参数校验不通过。

可选地，所述接口管理方法还包括：

在接收到接口测试请求时，获取所述接口测试请求对应待测试的目标接口标识；

查询预设的注解对象存储数据库，获取所述目标接口标识对应的接口注解和参数注解；

根据所述接口注解和所述参数注解配置参数生成器，并通过所述参数生成器生成接口测试值；

按所述接口测试值测试所述目标接口标识对应的目标接口，得到接口测试结果，并生成包含所述接口测试结果的测试报告。

可选地，所述根据所述接口注解和所述参数注解配置参数生成器，并通过所述参数生成器生成接口测试值的步骤，包括：

根据所述接口注解确定所述目标接口标识对应接口的接口等级；

若所述接口等级为第一等级，则按所述参数注解配置生成固定参数生成器，并通过所述固定参数生成器生成第一接口测试值；

若所述接口等级为第二等级，则按所述参数注解配置生成随机参数生成器，并通过所述随机参数生成器生成第二接口测试值；

若所述接口等级为第三等级，则按所述参数注解配置生成模型参数生成器，并通过所述模型参数生成器生成第三接口测试值。

可选地，所述按所述接口测试值测试所述目标接口标识对应的目标接口，得到接口测试结果，并生成包含所述接口测试结果的测试报告的步骤，包括：

获取所述目标接口标识对应的接口数量；

在所述接口数量大于预设阈值时，将携带所述接口测试值的测试任务线程提交到线程池中；

执行所述线程池中的各所述测试任务线程，得到各所述目标接口标识对应目标接口的接口测试结果，并生成所述接口测试结果对应的测试报告。

此外，为实现上述目的，本发明还提供一种接口管理装置，所述接口管理装置包括：

请求接收模块，用于在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型；

第一获取模块，用于查询预设的注解对象存储数据库，获取所述接口标识对应的接口注解；

第二获取模块，用于确定所述接口注解中包含的接口参数，获取所述注解对象存储数据库中各所述接口参数对应的参数注解；

文档生成模块，用于根据所述文档类型处理所述参数注解生成接口文档。

可选地，所述接口管理装置包括：

接口定义模块，用于在接收到接口定义请求时，输出接口定义窗口，以提示开发者输入各接口的接口注解，其中，所述接口注解包括：接口ID、接口名称和接口类型；

参数定义模块，用于接收基于所述接口定义窗口输入的各接口的接口注解，获取所述接口注解中包含的接口参数，并输出参数定义窗口，以提示开发者输入各所述接口参数的参数注解，其中，所述参数注解包括：字段名、字段描述、字段类型、字段长度和是否必输入；

数据保存模块，用于在检测到接口定义完成时，获取各所述接口对应的所述接口注解和所述参数注解，将所述接口注解和所述参数注解保存至预设的注解对象存储数据库。

可选地，所述文档生成模块，包括：

第一生成单元，用于若所述文档类型是EXCEL类型，则将各所述参数注解组合成字符串序列，并将各所述字符串序列写入EXCEL模板中，生成EXCEL格式的接口文档；

第二生成单元，用于若所述文档类型是Markdown类型，则将各所述参数注解按照Markdown的格式转化生成文本字符串，并将各所述文本字符串写入到Showdoc模板中，生成Showdoc格式的接口文档。

可选地，所述接口管理装置包括：

参数校验模块，用于在接收到接口参数校验请求时，获取所述接口参数校验请求对应待校验的目标接口参数；

查询判断模块，用于查询预设的注解对象存储数据库，获取所述目标接口参数对应的目标参数注解，并判断所述目标接口参数是否符合所述目标参数注解；

第一判定模块，用于若所述目标接口参数符合所述目标参数注解，则输出参数校验通过；

第二判定模块，用于若所述目标接口参数不符合所述目标参数注解，则输出参数校验不通过。

可选地，所述接口管理装置包括：

接口测试模块，用于在接收到接口测试请求时，获取所述接口测试请求对应待测试的目标接口标识；

注解获取模块，用于查询预设的注解对象存储数据库，获取所述目标接口标识对应的接口注解和参数注解；

测试值生成模块，用于根据所述接口注解和所述参数注解配置参数生成器，并通过所述参数生成器生成接口测试值；

报告生成模块，用于按所述接口测试值测试所述目标接口标识对应的目标接口，得到接口测试结果，并生成包含所述接口测试结果的测试报告。

可选地，所述测试值生成模块，包括：

等级确定单元，用于根据所述接口注解确定所述目标接口标识对应接口的接口等级；

第一生成单元，用于若所述接口等级为第一等级，则按所述参数注解配置生成固定参数生成器，并通过所述固定参数生成器生成第一接口测试值；

第二生成单元，用于若所述接口等级为第二等级，则按所述参数注解配置生成随机参数生成器，并通过所述随机参数生成器生成第二接口测试值；

第三生成单元，用于若所述接口等级为第三等级，则按所述参数注解配置生成模型参数生成器，并通过所述模型参数生成器生成第三接口测试值。

可选地，所述报告生成模块，包括：

数量获取单元，用于获取所述目标接口标识对应的接口数量；

任务提交单元，用于在所述接口数量大于预设阈值时，将携带所述接口测试值的测试任务线程提交到线程池中；

任务执行单元，用于执行所述线程池中的各所述测试任务线程，得到各所述目标接口标识对应目标接口的接口测试结果，并生成所述接口测试结果对应的测试报告。

此外，为实现上述目的，本发明还提供一种接口管理设备，所述接口管理设备包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的接口管理程序，所述接口管理程序被所述处理器执行时实现如上所述的接口管理方法的步骤。

此外，为实现上述目的，本发明还提供一种计算机可读存储介质，所述计算机可读存储介质上存储有接口管理程序，所述接口管理程序被处理器执行时实现如上所述的接口管理方法的步骤。

本发明提供一种接口管理方法、装置、设备及计算机可读存储介质。本发明实施例中，接口管理设备在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型；查询预设的注解对象存储数据库，获取所述接口标识对应的接口注解，并确定所述接口注解中包含的接口参数；获取所述注解对象存储数据库中各所述接口参数对应的参数注解，根据所述文档类型处理所述参数注解生成接口文档。本实施例中接口管理设备获取注解对象存储数据库中接口注解，并根据接口注解准确地获取到接口对应的接口参数，和接口参数对应的参数注解，并利用该参数注解生成规范化的接口文档；本发明实施例中不需要开发人员进行手动编辑接口文档，减少了开发人员的工作量，提高了接口文档的生成效率。

附图说明

图1是本发明实施例方案涉及的硬件运行环境的设备结构示意图；

图2为本发明接口管理方法第一实施例的流程示意图；

图3为本发明接口管理方法第三实施例的流程示意图；

图4为本发明接口管理装置一实施例的功能模块示意图。

本发明目的的实现、功能特点及优点将结合实施例，参照附图做进一步说明。

具体实施方式

应当理解，此处所描述的具体实施例仅仅用以解释本发明，并不用于限定本发明。

如图1所示，图1是本发明实施例方案涉及的硬件运行环境的设备结构示意图。

本发明实施例接口管理设备可以是PC机或服务器。

如图1所示，该接口管理设备可以包括：处理器1001，例如CPU，网络接口1004，用户接口1003，存储器1005，通信总线1002。其中，通信总线1002用于实现这些组件之间的连接通信。用户接口1003可以包括显示屏(Display)、输入单元比如键盘(Keyboard)，可选用户接口1003还可以包括标准的有线接口、无线接口。网络接口1004可选的可以包括标准的有线接口、无线接口(如WI-FI接口)。存储器1005可以是高速RAM存储器，也可以是稳定的存储器(non-volatile memory)，例如磁盘存储器。存储器1005可选的还可以是独立于前述处理器1001的存储装置。

本领域技术人员可以理解，图1中示出的设备结构并不构成对设备的限定，可以包括比图示更多或更少的部件，或者组合某些部件，或者不同的部件布置。

如图1所示，作为一种计算机存储介质的存储器1005中可以包括操作系统、网络通信模块、用户接口模块以及接口管理程序。

在图1所示的设备中，网络接口1004主要用于连接后台服务器，与后台服务器进行数据通信；用户接口1003主要用于连接客户端(用户端)，与客户端进行数据通信；而处理器1001可以用于调用存储器1005中存储的接口管理程序，并执行下述接口管理方法中的操作。

基于上述硬件结构，提出本发明接口管理方法实施例。

本发明接口管理方法第一实施例，包括：

在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型；

查询预设的注解对象存储数据库，获取所述接口标识对应的接口注解；

确定所述接口注解中包含的接口参数，并获取所述注解对象存储数据库中各所述接口参数对应的参数注解；

根据所述文档类型处理所述参数注解生成接口文档。

本实施例中，软件开发人员预先定义所有接口、以及所有接口参数的格式，具体地，包括：

步骤a1，在接收到接口定义请求时，输出接口定义窗口，以提示开发者输入各接口的接口注解，其中，所述接口注解包括：接口ID(identification接口标识)、接口名称和接口类型；

步骤a2，接收基于所述接口定义窗口输入的各接口的接口注解，获取所述接口注解中包含的接口参数，并输出参数定义窗口，以提示开发者输入各所述接口参数的参数注解，其中，所述参数注解包括：字段名、字段描述、字段类型、字段长度和是否必输入；

步骤a3，在检测到接口定义完成时，获取各所述接口对应的所述接口注解和所述参数注解，将所述接口注解和所述参数注解保存至预设的注解对象存储数据库。

本实施例中，接口管理设备通过接口定义窗口提示开发者定义规范化的接口注解，通过参数定义窗口提示开发者定义规范化的参数注解，并将规范化的接口注解和参数注解保存到预设的注解对象存储数据库；预设的注解对象存储数据库存储了所有接口、以及所有接口参数的格式，以根据规范化的接口注解和参数注解，生成统一格式的接口文档，具体地：

参照图2，图2为本发明接口管理方法第一实施例的流程示意图，所述接口管理方法包括：

步骤S10，在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型。

本实施例接口管理方法应用于接口管理设备，该接口管理设备可设置于金融行业的金融机构(银行机构、保险机构、证券机构等)中，接口管理设备接收接口文档生成请求，接口文档生成请求的触发方式不作具体限定，即，接口文档生成请求可以是用户主动触发的，例如，软件开发者基于预先定义的接口触发接口文档生成请求；此外，接口文档生成请求还可以是自动触发的，例如，接口管理设备检测到接口定义完成时，自动触发接口文档生成请求。

接口管理设备接收到接口文档生成请求时，接口管理设备获取接口文档生成请求对应的接口标识和文档类型，接口标识是指识别接口的标识信息，接口文档生成请求涉及到的接口的数量不作具体限定，即接口可以是一个或者多个；文档类型包括TXT类型、EXCEL类型、或者Showdoc类型。

步骤S20，查询预设的注解对象存储数据库，获取所述接口标识对应的接口注解，并确定所述接口注解中包含的接口参数。

接口管理设备遍历预设的注解对象存储数据库，获取接口标识对应的接口注解，其中，接口注解中包括但不仅限于接口ID、接口名称和接口类型，以使接口管理设备根据获取到的接口注解，确定接口标识对应的接口参数，并根据接口参数对应的参数注解，生成接口文档。

步骤S30，确定所述接口注解中包含的接口参数，并获取所述注解对象存储数据库中各所述接口参数对应的参数注解；

接口管理设备确定接口注解中包含的接口参数，具体地，包括：

实现方式一：接口注解中包含有接口ID与接口参数映射表，接口管理设备获取到接口注解之后，接口管理设备查询接口ID与接口参数映射表，获取该接口注解中包含的接口参数；

实现方式二：接口注解中设置接口参数集合，接口管理设备获取接口参数集合中包含的各个接口参数；

例如，接口管理设备根据银行账户余额查询接口的接口注解，确定接口注解中包含有银行账户参数、验证码参数等等。

本实施例中，通过查询预设的注解对象存储数据库获取到预先定义了的规范化的接口注解，并根据接口注解确定接口对应的接口参数，然后，接口管理设备获取注解对象存储数据库中接口参数对应的参数注解，以根据参数注解生成规范化的接口文档，即，

步骤S40，根据所述文档类型处理所述参数注解生成接口文档

接口管理设备判断文档类型是否为EXCEL类型或Markdown类型(Markdown一种轻量级的标记语言)，以生成对应的接口文档，具体地，包括：

步骤b1，若所述文档类型是EXCEL类型，则将各所述参数注解组合成字符串序列，并将各所述字符串序列写入EXCEL模板中，生成EXCEL格式的接口文档；

步骤b2，若所述文档类型是Markdown类型，则将各所述参数注解按照Markdown的格式转化生成文本字符串，并将各所述文本字符串写入到Showdoc模板中，生成Showdoc格式的接口文档。

本实施例中具体给出了两种文档类型的接口文档生成方式，即，若文档类型是EXCEL类型时，接口管理设备将各接口参数对应的参数注解组合成字符串序列，接口管理设备将字符串序列添加到EXCEL单元格的一行中，接口管理设备将各EXCEL单元格一行写入EXCEL模板中，生成EXCEL格式的接口文档；若文档类型是Markdown类型，接口管理设备将各接口参数对应的参数注解按照Markdown的格式生成文本字符串，并将生成的文本字符串写入到Showdoc模板中，生成Showdoc格式的接口文档。

本实施例中接口管理设备获取注解对象存储数据库中接口注解，并根据接口注解准确地获取到接口对应的接口参数，和接口参数对应的参数注解，并利用该参数注解生成规范化的接口文档；本发明实施例中不需要开发人员进行手动编辑接口文档，减少了开发人员的工作量，提高了接口文档的生成效率。

在银行机构等金融机构内采用上述接口文档生成方式，使得生成的接口文档格式统一，减少金融结构应用程序开发人员的工作量，提高了接口文档的生成效率，以此同时，统一格式的接口文档可以方便不同金融机构中不同的开发人员阅读。

进一步地，基于本发明接口管理方法第一实施例，提出本发明接口管理方法第二实施例。

本实施例与第一实施例的区别在于，本实施例中具体说明了利用生成的规范化的接口文档进行接口参数测试，具体地，包括：

在接收到接口参数校验请求时，获取所述接口参数校验请求对应待校验的目标接口参数。

接口管理设备接口参数校验请求，其中，接口参数校验请求的触发方式不作具体限定，即，接口参数校验请求可以是用户主动触发的，例如，接口开发人员每设置一个接口参数，就点击“接口参数校验”按键，触发接口参数校验请求；此外，接口参数校验请求还可以是自动触发的，例如，用户发送银行账户余额查询指令至银行业务处理器，银行业务处理器前置的接口管理设备拦截银行账户余额查询指令，并获取银行账户余额查询指令中的接口参数(接口参数包括：银行卡账户号和客户电话号码等等)，自动触发接口参数校验请求。

接口管理设备在接收到接口参数校验请求时，接口管理设备获取接口参数校验请求对应待校验的目标接口参数，以校验该目标接口参数，具体地：

查询预设的注解对象存储数据库，获取所述目标接口参数对应的目标参数注解，并判断所述目标接口参数是否符合所述目标参数注解。

接口管理设备查询预设的注解对象存储数据库，获取目标接口参数对应的目标参数注解，然后，接口管理设备判断待校验的目标接口参数是否符合目标参数注解，例如，接口管理设备获取接口参数为银行卡6217xxxx xxxx395，接口管理设备获取银行卡账户号对应的参数注解：字段名：银行卡账户号、字段长度19位、字段类型数字、必输，接口管理设备判断6217xxxx xxxx395是否符合目标参数注解，以输出参数校验结果。

本实施例中接口参数校验的方案应用在金融领域，通过对接口参数进行校验，可以有效地拦截接口参数不规范的操作请求，并减少了操作请求的量，以提高了金融业务处理操作效率。

若所述目标接口参数符合所述目标参数注解，则输出参数校验通过。

若目标接口参数符合目标参数注解，即，目标接口参数对应的字段名、字段描述、字段类型和字段长度，与目标参数注解中的字段名、字段描述、字段类型和字段长度相同，接口管理设备输出参数校验通过。

若所述目标接口参数不符合所述目标参数注解，则输出参数校验不通过。

若目标接口参数不符合目标参数注解，即，目标接口参数对应的字段名、字段描述、字段类型和字段长度，与目标参数注解中的字段名、字段描述、字段类型和字段长度存在任意一个或多个不相同，接口管理设备输出参数校验不通过。

本实施例中，接口管理设备接收到接口参数校验请求时，接口管理设备获取接口参数校验请求对应的目标接口参数，并获取接口文档中目标接口参数对应的接口注解，以根据接口注解对接口参数进行校验，本实施例中利用规范化的接口文档中的参数注解校验接口参数时，一方面可以保证接口参数校验较为全面，另外一方面可以接口管理设备按照其参数注解返回接口参数的校验结果，有效地避免了校验结果返回不规范的情况。

进一步地，参照图3，基于本发明接口管理方法上述实施例，提出本发明接口管理方法第三实施例。

本实施例与上述实施例的区别在于，本实施例中具体说明了利用规范化的接口注解和参数注解进行接口测试，具体地，包括：

步骤S50，在接收到接口测试请求时，获取所述接口测试请求对应待测试的目标接口标识。

接口管理设备接收接口测试请求，接收接口测试请求的触发方式不作具体限定，即，接收接口测试请求可以是用户主动触发的，例如，开发人员新开发一个接口后主动触发接口测试请求；此外，接收接口测试请求可以还是自动触发的，例如，接口管理设备检测到新增接口时，自动触发接口测试请求。

接口管理设备在接收到接口测试请求时，接口管理设备获取接口测试请求对应待测试的目标接口标识，以进行测试该目标接口标识对应的接口，具体地：

步骤S60，查询预设的注解对象存储数据库，获取所述目标接口标识对应的接口注解和参数注解。

接口管理设备查询预设的注解对象存储数据库，接口管理设备获取目标接口标识对应的接口注解和参数注解，以根据接口注解和参数注解自动生成目标接口标识对应的接口测试值，并利用生成的接口测试值进行接口测试。

步骤S70，根据所述接口注解和所述参数注解配置参数生成器，并通过所述参数生成器生成接口测试值；

具体地，包括：

步骤c1，根据所述接口注解确定所述目标接口标识对应接口的接口等级；

步骤c2，若所述接口等级为第一等级，则按所述参数注解配置生成固定参数生成器，并通过所述固定参数生成器生成第一接口测试值；

步骤c3，若所述接口等级为第二等级，则按所述参数注解配置生成随机参数生成器，并通过所述随机参数生成器生成第二接口测试值；

步骤c4，若所述接口等级为第三等级，则按所述参数注解配置生成模型参数生成器，并通过所述模型参数生成器生成第三接口测试值。

接口管理设备根据接口注解确定目标接口标识对应接口的接口等级，具体地，接口管理设备获取接口注解中的接口类型，其中，接口类型可以根据不同性质划分，例如，接口类型根据接口业务场景划分为金融数据输入接口、金融数据校验接口等等，接口管理设备按照接口类型确定目标接口标识对应接口的接口等级。

若接口等级为第一等级，即，接口管理设备判定接口的影响范围小，则接口管理设备按参数注解配置生成固定参数生成器(固定参数生成器是指用于生成唯一接口测试值的算法)，并通过固定参数生成器生成第一接口测试值，例如，金融机构中的日期校验接口，接口管理设备配置固定参数生成器，并通过该固定参数生成器生成当前时间对应的固定日期作为第一接口测试值。

若接口等级为第二等级，即，接口管理设备判定接口的影响范围适中，则接口管理设备按参数注解配置生成随机参数生成器(随机参数生成器是指用于生成随机接口测试值的算法)，并通过随机参数生成器生成第二接口测试值，例如，金融机构中的银行卡账户校验接口，接口管理设备配置随机参数生成器，并通过该随机参数生成器生成银行卡号作为第二接口测试值。

若接口等级为第三等级，即，接口管理设备判定接口的影响范围大，则接口管理设备按参数注解配置生成模型参数生成器(模型参数生成器是指可以智能生成不同接口参数值的参数生成算法)，并通过模型参数生成器生成第三接口测试值，例如，金融机构中的转账金额校验接口，接口管理设备配置模型参数生成器，并通过该模型参数生成器生成转账金额作为第三接口测试值。

步骤S80，按所述接口测试值测试所述目标接口标识对应的目标接口，得到接口测试结果，并生成包含所述接口测试结果的测试报告。

接口管理设备按接口测试值测试目标接口标识对应的目标接口，即，接口管理设备将生成的接口测试值输入到该目标接口标识对应的接口中，进行接口测试得到接口测试结果，接口管理设备将生成的接口测试结果输入到预设的报告模板中，生成包含接口测试结果的测试报告。

本实施例中，接口管理设备查询预设的注解对象存储数据库，获取目标接口标识对应的接口注解和参数注解，并根据接口注解和参数注解进行接口测试，本实施例中可以对批量接口进行测试，可以保证全部的接口都进行了测试，有效地避免了测试遗漏的情况。

进一步地，基于本发明接口管理方法第三实施例，提出本发明接口管理方法第四实施例。

本实施例是第三实施例中步骤S80的细化，具体地，包括：

获取所述目标接口标识对应的接口数量；

在所述接口数量大于预设阈值时，将携带所述接口测试值的测试任务线程提交到线程池中；

执行所述线程池中的各所述测试任务线程，得到各所述目标接口标识对应目标接口的接口测试结果，并生成所述接口测试结果对应的测试报告。

接口测试设备获取目标接口标识对应的接口数量，并判断接口数量是否大于预设阈值，其中预设阈值可以根据具体场景设置，例如，预设阈值设置为100个，若接口数量小于或等于预设阈值，接口管理设备对目标接口标识对应的接口进行单个测试。

在接口数量大于预设阈值时，即，接口管理设备确定待测试的接口数量较多，接口管理设备将携带接口测试值的测试任务线程提交到线程池中；接口管理设备执行线程池中的各测试任务线程，得到各目标接口标识对应目标接口的接口测试结果，接口管理设备将生成的接口测试结果输入到预设的报告模板中，并生成接口测试结果对应的测试报告。

本实施例中，接口管理设备通过设置测试线程池对接口进行批量测试，提高看接口测试的测试效率。

参照图4，本发明还提供一种接口管理装置，所述接口管理装置包括：

请求接收模块10，用于在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型；

第一获取模块20，用于查询预设的注解对象存储数据库，获取所述接口标识对应的接口注解；

第二获取模块30，用于确定所述接口注解中包含的接口参数，获取所述注解对象存储数据库中各所述接口参数对应的参数注解；

文档生成模块40，用于根据所述文档类型处理所述参数注解生成接口文档。

在一实施例中，所述接口管理装置包括：

接口定义模块，用于在接收到接口定义请求时，输出接口定义窗口，以提示开发者输入各接口的接口注解，其中，所述接口注解包括：接口ID、接口名称和接口类型；

参数定义模块，用于接收基于所述接口定义窗口输入的各接口的接口注解，获取所述接口注解中包含的接口参数，并输出参数定义窗口，以提示开发者输入各所述接口参数的参数注解，其中，所述参数注解包括：字段名、字段描述、字段类型、字段长度和是否必输入；

数据保存模块，用于在检测到接口定义完成时，获取各所述接口对应的所述接口注解和所述参数注解，将所述接口注解和所述参数注解保存至预设的注解对象存储数据库。

在一实施例中，所述文档生成模块40，包括：

第一生成单元，用于若所述文档类型是EXCEL类型，则将各所述参数注解组合成字符串序列，并将各所述字符串序列写入EXCEL模板中，生成EXCEL格式的接口文档；

第二生成单元，用于若所述文档类型是Markdown类型，则将各所述参数注解按照Markdown的格式转化生成文本字符串，并将各所述文本字符串写入到Showdoc模板中，生成Showdoc格式的接口文档。

在一实施例中，所述接口管理装置包括：

参数校验模块，用于在接收到接口参数校验请求时，获取所述接口参数校验请求对应待校验的目标接口参数；

查询判断模块，用于查询预设的注解对象存储数据库，获取所述目标接口参数对应的目标参数注解，并判断所述目标接口参数是否符合所述目标参数注解；

第一判定模块，用于若所述目标接口参数符合所述目标参数注解，则输出参数校验通过；

第二判定模块，用于若所述目标接口参数不符合所述目标参数注解，则输出参数校验不通过。

在一实施例中，所述接口管理装置包括：

接口测试模块，用于在接收到接口测试请求时，获取所述接口测试请求对应待测试的目标接口标识；

注解获取模块，用于查询预设的注解对象存储数据库，获取所述目标接口标识对应的接口注解和参数注解；

测试值生成模块，用于根据所述接口注解和所述参数注解配置参数生成器，并通过所述参数生成器生成接口测试值；

报告生成模块，用于按所述接口测试值测试所述目标接口标识对应的目标接口，得到接口测试结果，并生成包含所述接口测试结果的测试报告。

在一实施例中，所述测试值生成模块，包括：

等级确定单元，用于根据所述接口注解确定所述目标接口标识对应接口的接口等级；

第一生成单元，用于若所述接口等级为第一等级，则按所述参数注解配置生成固定参数生成器，并通过所述固定参数生成器生成第一接口测试值；

第二生成单元，用于若所述接口等级为第二等级，则按所述参数注解配置生成随机参数生成器，并通过所述随机参数生成器生成第二接口测试值；

第三生成单元，用于若所述接口等级为第三等级，则按所述参数注解配置生成模型参数生成器，并通过所述模型参数生成器生成第三接口测试值。

在一实施例中，所述报告生成模块，包括：

数量获取单元，用于获取所述目标接口标识对应的接口数量；

任务提交单元，用于在所述接口数量大于预设阈值时，将携带所述接口测试值的测试任务线程提交到线程池中；

任务执行单元，用于执行所述线程池中的各所述测试任务线程，得到各所述目标接口标识对应目标接口的接口测试结果，并生成所述接口测试结果对应的测试报告。

上述各程序模块所执行的方法可参照本发明接口管理方法各个实施例，此处不再赘述。

本发明还提供一种计算机可读存储介质。

本发明计算机可读存储介质上存储有接口管理程序，所述接口管理程序被处理器执行时实现如上所述的接口管理方法的步骤。

其中，在所述处理器上运行的接口管理程序被执行时所实现的方法可参照本发明接口管理方法各个实施例，此处不再赘述。

需要说明的是，在本文中，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者系统不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者系统所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括该要素的过程、方法、物品或者系统中还存在另外的相同要素。

上述本发明实施例序号仅仅为了描述，不代表实施例的优劣。

通过以上的实施方式的描述，本领域的技术人员可以清楚地了解到上述实施例方法可借助软件加必需的通用硬件平台的方式来实现，当然也可以通过硬件，但很多情况下前者是更佳的实施方式。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分可以以软件产品的形式体现出来，该计算机软件产品存储在如上所述的一个存储介质(如ROM/RAM、磁碟、光盘)中，包括若干指令用以使得一台终端设备(可以是手机，计算机，服务器，空调器，或者网络设备等)执行本发明各个实施例所述的方法。

以上仅为本发明的优选实施例，并非因此限制本发明的专利范围，凡是利用本发明说明书及附图内容所作的等效结构或等效流程变换，或直接或间接运用在其他相关的技术领域，均同理包括在本发明的专利保护范围内。

Claims (16)

1.一种接口管理方法，其特征在于，所述接口管理方法包括如下步骤：

在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型；

查询预设的注解对象存储数据库，获取所述接口标识对应的接口注解；

确定所述接口注解中包含的接口参数，并获取所述注解对象存储数据库中各所述接口参数对应的参数注解；

根据所述文档类型处理所述参数注解生成接口文档。

2.如权利要求1所述的接口管理方法，其特征在于，所述在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型的步骤之前，包括：

在接收到接口定义请求时，输出接口定义窗口，以提示开发者输入各接口的接口注解，其中，所述接口注解包括：接口ID、接口名称和接口类型；

接收基于所述接口定义窗口输入的各接口的接口注解，获取所述接口注解中包含的接口参数，并输出参数定义窗口，以提示开发者输入各所述接口参数的参数注解，其中，所述参数注解包括：字段名、字段描述、字段类型、字段长度和是否必输入；

在检测到接口定义完成时，获取各所述接口对应的所述接口注解和所述参数注解，将所述接口注解和所述参数注解保存至预设的注解对象存储数据库。

3.如权利要求1所述的接口管理方法，其特征在于，所述根据所述文档类型处理所述参数注解生成接口文档的步骤，包括：

若所述文档类型是EXCEL类型，则将各所述参数注解组合成字符串序列，并将各所述字符串序列写入EXCEL模板中，生成EXCEL格式的接口文档；

若所述文档类型是Markdown类型，则将各所述参数注解按照Markdown的格式转化生成文本字符串，并将各所述文本字符串写入到Showdoc模板中，生成Showdoc格式的接口文档。

4.如权利要求1所述的接口管理方法，其特征在于，所述接口管理方法包括：

在接收到接口参数校验请求时，获取所述接口参数校验请求对应待校验的目标接口参数；

查询预设的注解对象存储数据库，获取所述目标接口参数对应的目标参数注解，并判断所述目标接口参数是否符合所述目标参数注解；

若所述目标接口参数符合所述目标参数注解，则输出参数校验通过；

若所述目标接口参数不符合所述目标参数注解，则输出参数校验不通过。

5.如权利要求1至4任意一项所述的接口管理方法，其特征在于，所述接口管理方法还包括：

在接收到接口测试请求时，获取所述接口测试请求对应待测试的目标接口标识；

查询预设的注解对象存储数据库，获取所述目标接口标识对应的接口注解和参数注解；

根据所述接口注解和所述参数注解配置参数生成器，并通过所述参数生成器生成接口测试值；

按所述接口测试值测试所述目标接口标识对应的目标接口，得到接口测试结果，并生成包含所述接口测试结果的测试报告。

6.如权利要求5所述的接口管理方法，其特征在于，所述根据所述接口注解和所述参数注解配置参数生成器，并通过所述参数生成器生成接口测试值的步骤，包括：

根据所述接口注解确定所述目标接口标识对应接口的接口等级；

若所述接口等级为第一等级，则按所述参数注解配置生成固定参数生成器，并通过所述固定参数生成器生成第一接口测试值；

若所述接口等级为第二等级，则按所述参数注解配置生成随机参数生成器，并通过所述随机参数生成器生成第二接口测试值；

若所述接口等级为第三等级，则按所述参数注解配置生成模型参数生成器，并通过所述模型参数生成器生成第三接口测试值。

7.如权利要求5所述的接口管理方法，其特征在于，所述按所述接口测试值测试所述目标接口标识对应的目标接口，得到接口测试结果，并生成包含所述接口测试结果的测试报告的步骤，包括：

获取所述目标接口标识对应的接口数量；

在所述接口数量大于预设阈值时，将携带所述接口测试值的测试任务线程提交到线程池中；

执行所述线程池中的各所述测试任务线程，得到各所述目标接口标识对应目标接口的接口测试结果，并生成所述接口测试结果对应的测试报告。

8.一种接口管理装置，其特征在于，所述接口管理装置包括：

请求接收模块，用于在接收到接口文档生成请求时，确定所述接口文档生成请求对应的接口标识和文档类型；

第一获取模块，用于查询预设的注解对象存储数据库，获取所述接口标识对应的接口注解；

第二获取模块，用于确定所述接口注解中包含的接口参数，获取所述注解对象存储数据库中各所述接口参数对应的参数注解；

文档生成模块，用于根据所述文档类型处理所述参数注解生成接口文档。

9.如权利要求8所述的接口管理装置，其特征在于，所述接口管理装置包括：

接口定义模块，用于在接收到接口定义请求时，输出接口定义窗口，以提示开发者输入各接口的接口注解，其中，所述接口注解包括：接口ID、接口名称和接口类型；

参数定义模块，用于接收基于所述接口定义窗口输入的各接口的接口注解，获取所述接口注解中包含的接口参数，并输出参数定义窗口，以提示开发者输入各所述接口参数的参数注解，其中，所述参数注解包括：字段名、字段描述、字段类型、字段长度和是否必输入；

数据保存模块，用于在检测到接口定义完成时，获取各所述接口对应的所述接口注解和所述参数注解，将所述接口注解和所述参数注解保存至预设的注解对象存储数据库。

10.如权利要求8所述的接口管理装置，其特征在于，所述文档生成模块，包括：

第一生成单元，用于若所述文档类型是EXCEL类型，则将各所述参数注解组合成字符串序列，并将各所述字符串序列写入EXCEL模板中，生成EXCEL格式的接口文档；

第二生成单元，用于若所述文档类型是Markdown类型，则将各所述参数注解按照Markdown的格式转化生成文本字符串，并将各所述文本字符串写入到Showdoc模板中，生成Showdoc格式的接口文档。

11.如权利要求8所述的接口管理装置，其特征在于，所述接口管理装置包括：

参数校验模块，用于在接收到接口参数校验请求时，获取所述接口参数校验请求对应待校验的目标接口参数；

查询判断模块，用于查询预设的注解对象存储数据库，获取所述目标接口参数对应的目标参数注解，并判断所述目标接口参数是否符合所述目标参数注解；

第一判定模块，用于若所述目标接口参数符合所述目标参数注解，则输出参数校验通过；

第二判定模块，用于若所述目标接口参数不符合所述目标参数注解，则输出参数校验不通过。

12.如权利要求8至11任意一项所述的接口管理装置，其特征在于，所述接口管理装置包括：

接口测试模块，用于在接收到接口测试请求时，获取所述接口测试请求对应待测试的目标接口标识；

注解获取模块，用于查询预设的注解对象存储数据库，获取所述目标接口标识对应的接口注解和参数注解；

测试值生成模块，用于根据所述接口注解和所述参数注解配置参数生成器，并通过所述参数生成器生成接口测试值；

报告生成模块，用于按所述接口测试值测试所述目标接口标识对应的目标接口，得到接口测试结果，并生成包含所述接口测试结果的测试报告。

13.如权利要求12所述的接口管理装置，其特征在于，所述测试值生成模块，包括：

等级确定单元，用于根据所述接口注解确定所述目标接口标识对应接口的接口等级；

第一生成单元，用于若所述接口等级为第一等级，则按所述参数注解配置生成固定参数生成器，并通过所述固定参数生成器生成第一接口测试值；

第二生成单元，用于若所述接口等级为第二等级，则按所述参数注解配置生成随机参数生成器，并通过所述随机参数生成器生成第二接口测试值；

第三生成单元，用于若所述接口等级为第三等级，则按所述参数注解配置生成模型参数生成器，并通过所述模型参数生成器生成第三接口测试值。

14.如权利要求12所述的接口管理装置，其特征在于，所述报告生成模块，包括：

数量获取单元，用于获取所述目标接口标识对应的接口数量；

任务提交单元，用于在所述接口数量大于预设阈值时，将携带所述接口测试值的测试任务线程提交到线程池中；

任务执行单元，用于执行所述线程池中的各所述测试任务线程，得到各所述目标接口标识对应目标接口的接口测试结果，并生成所述接口测试结果对应的测试报告。

15.一种接口管理设备，其特征在于，所述接口管理设备包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的接口管理程序，所述接口管理程序被所述处理器执行时实现如权利要求1至7中任一项所述的接口管理方法的步骤。

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