一种处理API返回结果的方法、智能插件系统及电子设备技术方案

本发明专利技术公开了一种处理API返回结果的方法、智能插件系统及电子设备，该方法包括：创建满足业务场景的数据结构作为插件的元数据结构，并与选择的API接口进行绑定；编写插件的元数据配置，使元数据结构中相关属性配置在同一个管道，相互独立的属性则配置在不同的管道；管道内设置有串行的若干个过滤器；通过API

【技术实现步骤摘要】
一种处理API返回结果的方法、智能插件系统及电子设备


[0001]本专利技术涉及计算机
，尤其涉及一种基于管道过滤器模式处理API返回结果的方法、智能插件系统及电子设备。

技术介绍

[0002]现今市面上出现了很多API接口服务平台，平台通过接口注册、接口治理(包括授权、监控、隔离、限流和降级等技术)、服务编排、发布调用等功能，为不同系统之间提供数据对接和交互，同时实现了系统之间的解耦。但是，由于现在很多API平台对接口的返回结果处理比较弱，导致存在以下缺点：
[0003]1、市面上API的返回结果只能按API接口的输出格式返回，如工资查询接口返回员工每个月的工资明细，接口调用方可用于列表查询，当新增需求展示个人年度累计工资及其分项时，需要再注册一个工资查询的新接口，从而造成接口提供方的工作量增加。
[0004]2、对于直接查询数据库表的这一类API接口，虽然创建很容易，接口的入参和出参都是表字段，但是，这类接口只能返回一行或多行表记录数据，如果是统计接口则需要查数仓加工后的统计表，但接口输出格式仍然是ROW，不能得到对象属性是数组甚至更多嵌套的返回结果，难以适配大屏统计分析所需的数据结构。
[0005]3、API接口服务平台大都支持服务编排功能，编排的中间参数往往是上一步API的返回结果，编排的最终结果通常是最后一步API的返回或是对多个API的返回结果进行整合。由于API接口输出格式固定，使得很多场景不能采用已有的API进行编排，而是为了编排的中间参数或最终结果而去定向新增API，从而导致服务编排的易用性较差。

技术实现思路

[0006]本专利技术的目的在于提出一种处理API返回结果的方法、智能插件系统及电子设备，能够实现对API返回结果进行强处理，以满足各种业务场景的数据结构，从而提高生产效率，也提升了API平台的智能化程度。
[0007]为达此目的，本专利技术采用以下技术方案：
[0008]一种处理API返回结果的方法，包括以下步骤：
[0009]创建满足业务场景的数据结构作为插件的元数据结构，并与选择的API接口进行绑定；
[0010]编写插件的元数据配置，使元数据结构中相关属性配置在同一个管道，相互独立的属性则配置在不同的管道；所述管道内设置有串行的若干个过滤器；
[0011]通过API
‑
Gateway调用接口，使API返回结果进入预先配置的一个或多个并行的所述管道中；
[0012]利用所述管道内部串行的各所述过滤器对所述API返回结果进行层层加工，获得加工结果；
[0013]对所述加工结果进行汇总并返回给接口调用方。
[0014]作为本专利技术的优选，所述创建满足业务场景的数据结构作为插件的元数据结构，并与选择的API接口进行绑定包括：
[0015]在API接口平台创建数据表或自定义SQL的API，获得数据API；
[0016]选择一个数据API，编写满足业务场景的数据结构作为插件的元数据结构；
[0017]将所述元数据结构与所述数据API进行绑定，获得智能API。
[0018]其中，根据业务场景的不同，同一个数据API与不同的所述元数据结构进行绑定可以形成多个智能API。
[0019]作为本专利技术的优选，所述编写插件的元数据配置包括：
[0020]创建元数据配置；
[0021]在所述元数据配置中声明一个或多个管道，所述管道的类型设置为分组管道或普通管道；
[0022]在所述管道中新建若干个过滤器配置项，所述过滤器配置项包括名称及若干个函数；其中，所述名称为所述元数据结构的属性；所述函数以数据项或常量作为参数；
[0023]获取所述数据API的返回参数,作为所述函数的参数选项；所述函数也可以配置到管道上；
[0024]发布。
[0025]作为本专利技术的优选，所述通过API
‑
Gateway调用接口包括：
[0026]向API
‑
Gateway发起请求，调用和插件绑定的智能API接口，网关鉴权通过后将请求转发给API接口平台；
[0027]所述API接口平台连接内部数仓或外部数据源并查询数据表，查询的数据作为API返回结果进入插件的数据源端，并由所述数据源端进入一个或多个管道内。
[0028]作为本专利技术的优选，在所述API返回结果进入管道前，插件根据元数据配置预先初始化各管道，以使各管道对接所述数据源端。
[0029]作为本专利技术的优选，在所述API返回结果进入管道后，首先判断管道类型，如果是分组管道，执行分组函数；如果是普通管道，跳转到下一步。
[0030]作为本专利技术的优选，一个所述过滤器负责加工所述元数据结构的一个属性，属性值为所述过滤器加工的结果。
[0031]作为本专利技术的优选，过滤器的函数包括select选择器、case条件判断以及aggregate聚合函数等；其中，select函数输入的可以是常量，也可以是接口返回参数的列，结合condition条件筛选出数据；aggregate聚合函数在分组管道中使用，输入接口返回参数的列，可以sum求和、avg求平均、count求数量；case函数输入一组对象，该对象包括四个要素：when:接口返回参数的列、opt:等于、target:常量、source:输出结果。
[0032]作为本专利技术的优选，所述对加工结果进行汇总并返回给接口调用方包括：
[0033]对进入数据终端的加工结果进行汇总；
[0034]利用数据终端将元数据结构所有的属性与属性值构成一个JSON对象或数组,并返回给接口调用方。
[0035]本专利技术还提供了一种处理API返回结果的智能插件系统，包括：
[0036]元数据结构模块，用于创建满足业务场景的数据结构作为插件的元数据结构，并与选择的API接口进行绑定；
[0037]元数据配置模块，用于编写插件的元数据配置，使元数据结构中相关属性配置在同一个管道，相互独立的属性则配置在不同的管道；所述管道内设置有串行的若干个过滤器；
[0038]调用模块，用于通过API
‑
Gateway调用接口，使API返回结果通过数据源端流进预先配置的一个或多个并行的管道中；
[0039]处理模块，用于利用所述管道内部串行的各过滤器对所述API返回结果进行层层加工，获得加工结果；
[0040]数据终端，用于对所述加工结果进行汇总并返回给接口调用方。
[0041]本专利技术还提供了一种电子设备，包括处理器以及存储有执行指令的存储器，当所述处理器执行所述执行指令时，执行上述的方法。
[0042]本专利技术的有益效果为：本专利技术的一种处理API返回结果的方法、智能插件系统及电子设备，在API接口发布前对API返回参数进行预处理，先定义满足业务场景的数据结构作为元数据结构，并与选择的API接口进行绑定；再对元数据配置相应的API返回参数和管本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种处理API返回结果的方法，其特征在于，包括以下步骤：创建满足业务场景的数据结构作为插件的元数据结构，并与选择的API接口进行绑定；编写插件的元数据配置，使元数据结构中相关属性配置在同一个管道，相互独立的属性则配置在不同的管道；所述管道内设置有串行的若干个过滤器；通过API
‑
Gateway调用接口，使API返回结果进入预先配置的一个或多个并行的所述管道中；利用所述管道内部串行的各所述过滤器对所述API返回结果进行层层加工，获得加工结果；对所述加工结果进行汇总并返回给接口调用方。2.根据权利要求1所述的处理API返回结果的方法，其特征在于，所述创建满足业务场景的数据结构作为插件的元数据结构，并与选择的API接口进行绑定包括：在API接口平台创建数据表或自定义SQL的API，获得数据API；选择一个数据API，编写满足业务场景的数据结构作为插件的元数据结构；将所述元数据结构与所述数据API进行绑定，获得智能API。3.根据权利要求2所述的处理API返回结果的方法，其特征在于，所述编写插件的元数据配置包括：创建元数据配置；在所述元数据配置中声明一个或多个管道，所述管道的类型设置为分组管道或普通管道；在所述管道中新建若干个过滤器配置项，所述过滤器配置项包括名称及若干个函数；获取所述数据API的返回参数,作为所述函数的参数选项；发布。4.根据权利要求3所述的处理API返回结果的方法，其特征在于，所述通过API
‑
Gateway调用接口包括：向API
‑
Gateway发起请求，调用和插件绑定的智能API接口，网关鉴权通过后将请求转发给API接口平台；所述API接口平台连接内部数仓或外部数据源并查询数据表，查询的数据作为API返回结果进...

【专利技术属性】
技术研发人员：汪飞，盛振宇，师莎，
申请(专利权)人：中电云数智科技有限公司，
类型：发明
国别省市：