一种API结果输出方法、装置、设备及介质

技术领域

本申请涉及软件技术领域，特别涉及一种API结果输出方法、装置、设备及介质。

背景技术

在实际应用中，为了适用于不同的场景，经常需要修改同一API(即ApplicationProgramming Interface，应用程序接口)的输出结果来满足不同场景的需求。

目前，改变API输出结果通常都是通过后端编码实现的，只要进行编码就会带来一定的编译及重新部署等成本，影响整个研发效率。并且，开发人员机械式的为了不同的输出效果重复编码，同时bug产生几率上升，程序准确性下降。

发明内容

有鉴于此，本申请的目的在于提供一种API结果输出方法、装置、设备及介质，能够提升API输出结果的生成效率和准确度。其具体方案如下：

第一方面，本申请公开了一种API结果输出方法，包括：

获取API原始输出结果与预设模板文件；

从所述预设模板文件中提取出模板元素；

根据所述模板元素从所述API原始输出结果中提取目标数据源；

利用所述目标数据源生成符合所述预设模板文件的格式的数据，得到新的输出结果。

可选的，所述预设模板文件为JSON格式的模板文件。

可选的，所述获取API原始输出结果之后，还包括：

基于fastJson技术对所述API原始输出结果进行校验，判断所述API原始输出结果是否符合JSON解析规范，若所述API原始输出结果不符合所述JSON解析规范，则将所述API原始输出结果转换为符合所述JSON解析规范的目标结果数据，若所述API原始输出结果符合所述JSON解析规范，则将所述原始输出结果作为所述目标结果数据。

可选的，所述根据所述模板元素从所述API原始输出结果中提取目标数据源，包括：

基于JsonPath技术根据所述模板元素从所述目标结果数据中提取所述目标数据源。

可选的，所述利用所述目标数据源生成符合所述预设模板文件的格式的数据，包括：

对所述目标数据源进行格式处理、属性提取、别名处理以及脱敏处理，生成符合所述预设模板文件的格式的数据。

可选的，获取预设模板文件，包括：

根据需求从预设模板库中调取所述预设模板文件。

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

预先创建多个所述预设模板文件，然后添加至所述预设模板库。

第二方面，本申请公开了一种API结果输出装置，包括：

数据获取模块，用于获取API原始输出结果与预设模板文件；

模板元素提取模块，用于从所述预设模板文件中提取出模板元素；

目标数据源获取模块，用于根据所述模板元素从所述API原始输出结果中提取目标数据源；

输出结果生成模块，用于利用所述目标数据源生成符合所述预设模板文件的格式的数据，得到新的输出结果。

第三方面，本申请公开了一种电子设备，包括：

存储器，用于保存计算机程序；

处理器，用于执行所述计算机程序，以实现前述的API结果输出方法。

第四方面，本申请公开了一种计算机可读存储介质，用于保存计算机程序，所述计算机程序被处理器执行时实现前述的API结果输出方法。

可见，本申请先获取API原始输出结果与预设模板文件，然后从所述预设模板文件中提取出模板元素，之后根据所述模板元素从所述API原始输出结果中提取目标数据源，最后利用所述目标数据源生成符合所述预设模板文件的格式的数据，得到新的输出结果。这样，基于预设模板文件，从API原始输出结果中根据预设模板文件的模板元素提取目标数据源，生成符合所述预设模板文件的格式的数据，无需为了适应应用场景，针对性的进行编码，能够提升API输出结果的生成效率和准确度。

附图说明

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

图1为本申请公开的一种API结果输出方法流程图；

图2为本申请公开的一种API结果输出示意图；

图3为本申请公开的一种具体的API结果输出示意图；

图4为本申请公开的一种具体的API结果输出示意图；

图5为本申请公开的一种具体的API结果输出方法流程图；

图6为本申请公开的一种API结果输出装置结构示意图；

图7为本申请公开的一种电子设备结构图。

具体实施方式

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

目前，改变API输出结果通常都是通过后端编码实现的，只要进行编码就会带来一定的编译及重新部署等成本，影响整个研发效率。并且，开发人员机械式的为了不同的输出效果重复编码，同时bug产生几率上升，程序准确性下降。为此，本申请提供了一种API结果输出方案，能够提升API输出结果的生成效率和准确度。

参见图1所示，本申请实施例公开了一种API结果输出方法，包括：

步骤S11：获取API原始输出结果与预设模板文件。

其中，所述预设模板文件为JSON格式的模板文件。

步骤S12：从所述预设模板文件中提取出模板元素。

在具体的实施方式中，可以基于JsonPath技术从所述预设模板文件中提取出模板元素。

步骤S13：根据所述模板元素从所述API原始输出结果中提取目标数据源。

在具体的实施方式中，获取API原始输出结果之后，本实施例可以基于fastJson技术对所述API原始输出结果进行校验，判断所述API原始输出结果是否符合JSON解析规范，若所述API原始输出结果不符合所述JSON解析规范，则将所述API原始输出结果转换为符合所述JSON解析规范的目标结果数据，若所述API原始输出结果符合所述JSON解析规范，则将所述原始输出结果作为所述目标结果数据。然后基于JsonPath技术根据所述模板元素从所述目标结果数据中提取所述目标数据源。

具体的，本实施例在API原始输出结果为多个API结果时，将多个API结果生成一个符合JSON解析规范的文件，得到目标结果数据。

步骤S14：利用所述目标数据源生成符合所述预设模板文件的格式的数据，得到新的输出结果。

在具体的实施方式中，可以对所述目标数据源进行格式处理、属性提取、别名处理以及脱敏处理，生成符合所述预设模板文件的格式的数据。

其中，格式处理包括属性的嵌套格式处理，属性提取为从目标数据源中依据模板元素提取对应的属性，包括键名和键值，并且，若预设模板文件中定义了别名属性，需要进行别名处理，依据模板文件对相应属性的键名进行修改，比如，将键名name修改为personname，并且，可以基于预设模板文件进行脱敏处理，比如，对身份证号对应的键值进行隐藏。

需要指出的是，本实施例可以基于模板元素对目标数据源进行别名处理和脱敏处理，以满足业务侧最上层元数据处理、脱敏处理等频繁场合需求。同时基于预设模板文件，可以减少前端的数据理解成本，达到前端想要什么API输出结果结构，即可快速给出什么结构的效果。并且，利用模板定制结果方式，可以针对同一API，输出不同的结果格式，满足不同的研发需求，同时不需要编码、编译及部署，即配即生效，大幅度提高研发效率，有利于减少开发人员机械式的为了不同的输出效果重复编码，同时较少bug产生几率，提高准确性，一定程度降低项目风险。

例如，参见图2所示，本申请实施例公开了一种API结果输出示意图，参见图3所示，图3为本申请实施例公开的一种具体的API结果输出示意图，图4为本申请图4为本申请实施例公开的一种具体的API结果输出示意图。

在具体的实施方式中，可以依赖于JsonPath规则表达式技术、Java技术自定义模板，本实施根据实际场景需求，依据JSON规范制定模板文件，如下所示，为一个具体的模板文件：

其中，resultFormat为模板识别字，固定；field：属性定义；target：定义数据源，从源API结果中提取(通过JsonPath表达式定义)，alias：定义属性别名，输出改名；fields：以上结果嵌套，例如对象中的属性是对象的情况。

在具体的实施方式中，步骤1：利用java编码，对模板进行处理，完成模板中元素的提取，及结构的自解析。步骤2：结合:1中提取的模板元素，利用java编码，同时结合JsonPath规则处理技术，针对性进行数据源提取。步骤3：如果模板中定义了别名属性，对于别名定义，利用java技术单独处理。针对以上步骤1、2、3嵌套进行处理，直到模板中定义的所有层级全部处理完成。

可见，本申请实施例先获取API原始输出结果与预设模板文件，然后从所述预设模板文件中提取出模板元素，之后根据所述模板元素从所述API原始输出结果中提取目标数据源，最后利用所述目标数据源生成符合所述预设模板文件的格式的数据，得到新的输出结果。这样，基于预设模板文件，从API原始输出结果中根据预设模板文件的模板元素提取目标数据源，生成符合所述预设模板文件的格式的数据，无需为了适应应用场景，针对性的进行编码，能够提升API输出结果的生成效率和准确度。

参见图5所示，本申请实施例公开了一种具体的API结果输出方法，包括：

步骤S21：预先创建多个所述预设模板文件，然后添加至预设模板库。

在具体的实施方式中，实施例可以根据具体的业务线预先创建对应的模板文件，每个业务线均创建对应的模板文件，添加至预设模板库。

步骤S22：获取API原始输出结果以及根据需求从预设模板库中调取所述预设模板文件。

步骤S23：从所述预设模板文件中提取出模板元素。

步骤S24：根据所述模板元素从所述API原始输出结果中提取目标数据源。

步骤S25：利用所述目标数据源生成符合所述预设模板文件的格式的数据，得到新的输出结果。

参见图6所示，本申请实施例公开的一种API结果输出装置，包括：

数据获取模块11，用于获取API原始输出结果与预设模板文件；

模板元素提取模块12，用于从所述预设模板文件中提取出模板元素；

目标数据源获取模块13，用于根据所述模板元素从所述API原始输出结果中提取目标数据源；

输出结果生成模块14，用于利用所述目标数据源生成符合所述预设模板文件的格式的数据，得到新的输出结果。

可见，本申请实施例先获取API原始输出结果与预设模板文件，然后从所述预设模板文件中提取出模板元素，之后根据所述模板元素从所述API原始输出结果中提取目标数据源，最后利用所述目标数据源生成符合所述预设模板文件的格式的数据，得到新的输出结果。这样，基于预设模板文件，从API原始输出结果中根据预设模板文件的模板元素提取目标数据源，生成符合所述预设模板文件的格式的数据，无需为了适应应用场景，针对性的进行编码，能够提升API输出结果的生成效率和准确度。

其中，所述预设模板文件为JSON格式的模板文件。

所述装置还包括输出校验模块，用于在获取API原始输出结果之后，基于fastJson技术对所述API原始输出结果进行校验，判断所述API原始输出结果是否符合JSON解析规范，若所述API原始输出结果不符合所述JSON解析规范，则将所述API原始输出结果转换为符合所述JSON解析规范的目标结果数据，若所述API原始输出结果符合所述JSON解析规范，则将所述原始输出结果作为所述目标结果数据。

相应的，所述目标数据源获取模块13，具体用于基于JsonPath技术根据所述模板元素从所述目标结果数据中提取所述目标数据源。

所述输出结果生成模块14，具体用于对所述目标数据源进行格式处理、属性提取、别名处理以及脱敏处理，生成符合所述预设模板文件的格式的数据。

并且数据获取模块11，具体用于根据需求从预设模板库中调取所述预设模板文件。

进一步的，所述装置还包括模板库构建模块，用于预先创建多个所述预设模板文件，然后添加至所述预设模板库。

参见图7所示，本申请实施例公开了一种电子设备，包括处理器21和存储器22；其中，所述存储器22，用于保存计算机程序；所述处理器21，用于执行所述计算机程序，以实现前述实施例公开的API结果输出方法。

关于上述API结果输出方法的具体过程可以参考前述实施例中公开的相应内容，在此不再进行赘述。

进一步的，本申请实施例还公开了一种计算机可读存储介质，用于保存计算机程序，其中，所述计算机程序被处理器执行时实现前述实施例公开的API结果输出方法。

关于上述API结果输出方法的具体过程可以参考前述实施例中公开的相应内容，在此不再进行赘述。

本说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其它实施例的不同之处，各个实施例之间相同或相似部分互相参见即可。对于实施例公开的装置而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。

结合本文中所公开的实施例描述的方法或算法的步骤可以直接用硬件、处理器执行的软件模块，或者二者的结合来实施。软件模块可以置于随机存储器(RAM)、内存、只读存储器(ROM)、电可编程ROM、电可擦除可编程ROM、寄存器、硬盘、可移动磁盘、CD-ROM、或技术领域内所公知的任意其它形式的存储介质中。

以上对本申请所提供的一种API结果输出方法、装置、设备及介质进行了详细介绍，本文中应用了具体个例对本申请的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本申请的方法及其核心思想；同时，对于本领域的一般技术人员，依据本申请的思想，在具体实施方式及应用范围上均会有改变之处，综上所述，本说明书内容不应理解为对本申请的限制。