CN109213519A - 一种异构api适配处理方法及系统 - Google Patents

Abstract

本文公开了一种异构API适配处理方法及系统，此方法包括配置方法，具体包括：获取用于至少一源API类型的参数信息和参数转换规则；获取至少一目标API类型的参数定义；根据所述源API类型的参数信息和参数转换规则以及所述目标API类型的参数定义生成从所述目标API类型至所述源API类型的API转换配置信息。本发明可以方便地进行不同API类型的API请求转换，并且具备极强的扩展能力，对于系统不支持的API类型，只需开发相应的适配器以及设计新类型API的转换规则即可。本发明还为用户提供配置界面，使用户可方便的进行参数配置，提高用户使用体验，并且便于进一步的管理和使用。

Description

一种异构API适配处理方法及系统

技术领域

本发明涉及互联网技术领域，尤其涉及一种异构API适配处理方法及系统。

背景技术

随着数字化产业的快速发展，应用程序接口API(全称为Application ProgramInterface)在企业中起到的作用越来越重要。API可以作为企业内部业务系统之间的桥梁，进行业务数据的交换，联通不同类型的子系统；也可以作为企业和合作伙伴之间的枢纽，在两者之间进行数据的共享；还可以作为企业和用户之间的门户，将数据的读写权限通过API向用户开放。

但是API给企业带来便利的同时也带来诸多问题，其中最常见的问题就是由于业务系统开发架构、开发方式的不同造成的API协议、标准、格式的不统一，这极大的增加的企业基于API进行数据集成、开发的成本。

针对上述技术问题，目前最常见的两种解决方案分别是：

方案一，基于已有API进行二次开发，将API封装成统一的协议、标准、格式。

方案二，使用市场上的API网关、企业服务总线ESB(全称为Enterprise ServiceBus)类型的产品，对API进行统一接入和管理。

第一种方案的问题是开发成本高、灵活度低。

第二种方案的问题是功能有限，扩展性低。因为常见的API网关、ESB类型产品往往对接入的API类型都有限制，没办法很好的支持所有类型的API。

所以需要提供一种新的解决方案，以更低的使用成本、更高的扩展性和兼容性来解决API标准化的问题。

发明内容

为了解决上述技术问题，本发明提供了一种异构API适配处理方法及系统。

本发明提供的异构API适配处理方法，包括配置方法，所述配置方法包括：

获取用于至少一源API类型的参数信息和参数转换规则；获取至少一目标API类型的参数定义；根据所述源API类型的参数信息和参数转换规则以及所述目标API类型的参数定义生成从所述目标API类型至所述源API类型的API转换配置信息。

上述异构API适配处理方法还具有以下特点：

所述获取源API类型的参数信息和参数转换规则包括：提供与源API类型对应的第一交互配置界面，通过所述第一交互配置界面接收所述源API类型的参数信息和参数转换规则；

所述获取目标API类型的参数定义包括：提供与目标API类型对应的第二交互配置界面，通过所述第二交互配置界面接收所述目标API类型的参数定义。

上述异构API适配处理方法还具有以下特点：

所述执行方法包括：

接收API调用请求，确定所述API调用请求的目标API类型作为第一API类型，确定所述API调用请求的源API类型称为第二API类型，从已生成的API转换配置信息中查找并加载从所述第一API类型至所述第二API类型的API转换配置信息，根据查找到的API转换配置信息进行API调用请求的转换，发送转换后的符合第二API类型的API调用请求。

上述异构API适配处理方法还具有以下特点：

所述配置方法还包括：设置与所述源API类型对应的适配器；所述适配器用于接收API转换配置信息和API请求，将此API请求从所述API转换配置信息中的第一API类型的请求体转换为所述API转换配置信息中的第二API类型的请求体；

所述根据查找到的API转换配置信息进行API调用请求的转换包括：使用与所述第一API类型对应的适配器将所述API调用请求转换为符合第二API类型请求体的请求。

上述异构API适配处理方法还具有以下特点：

所述从已生成的API转换配置信息中查找并加载从所述第一API类型至所述第二API类型的API转换配置信息后，所述方法还包括：根据第一API类型的参数定义验证所述API调用请求中的参数是否符合定义要求。

上述异构API适配处理方法还具有以下特点：

所述根据查找到的API转换配置信息进行API调用请求的转换包括：使用参数转换语言通过编码的方式实现转换，具体包括：在需要进行参数逻辑转换时，使用参数转换语言通过编码的方式实现转换。

本发明提供的异构API适配处理系统，包括配置模块；

所述配置模块包括：

源API信息获取模块，用于获取用于至少一源API类型的参数信息和参数转换规则；

目标API信息获取模块，用于获取至少一目标API类型的参数定义；

配置信息生成模块，用于根据所述源API类型的参数信息和参数转换规则以及所述目标API类型的参数定义生成从所述目标API类型至所述源API类型的API转换配置信息。

上述异构API适配处理系统还具有以下特点：

所述源API信息获取模块包括：

第一交互单元，用于提供与源API类型对应的第一交互配置界面；

第一接收单元，用于通过所述第一交互配置界面接收所述源API类型的参数信息和参数转换规则；

所述源API信息获取模块包括：

第二交互单元，用于提供与目标API类型对应的第二交互配置界面；

第二接收单元，用于通过所述第二交互配置界面接收所述目标API类型的参数定义。

上述异构API适配处理系统还具有以下特点：

所述系统还包括执行模块，所述执行模块包括：

接收模块，用于接收API调用请求；

确定模块，用于确定所述API调用请求的目标API类型作为第一API类型，确定所述API调用请求的源API类型称为第二API类型；

加载模块，用于从已生成的API转换配置信息中查找并加载从所述第一API类型至所述第二API类型的API转换配置信息；

转换模块，用于根据查找到的API转换配置信息进行API调用请求的转换；

发送模块，用于发送转换后的符合第二API类型的API调用请求。

上述异构API适配处理系统还具有以下特点：

所述配置模块还包括：

适配器设置模块，用于设置与所述源API类型对应的适配器；所述适配器用于接收API转换配置信息和API请求，将此API请求从所述API转换配置信息中的第一API类型的请求体转换为所述API转换配置信息中的第二API类型的请求体；

所述转换模块，还用于使用与所述第一API类型对应的适配器将所述API调用请求转换为符合第二API类型请求体的请求。

上述异构API适配处理系统还具有以下特点：

所述加载模块和执行模块之间还包括验证模块，用于根据第一API类型的参数定义验证所述API调用请求中的参数是否符合定义要求。

上述异构API适配处理系统还具有以下特点：

所述转换模块，还用于在需要进行参数逻辑转换时，使用参数转换语言通过编码的方式实现转换。

本发明可以方便地进行不同API类型的API请求转换。本发明具备极强的扩展能力，对于系统不支持的API类型，只需开发相应的适配器以及设计新类型API的转换规则即可。本发明还为用户提供配置界面，使用户可方便的进行参数配置，提高用户使用体验，并且便于进一步的管理和使用。

附图说明

构成本发明的一部分的附图用来提供对本发明的进一步理解，本发明的示意性实施例及其说明用于解释本发明，并不构成对本发明的不当限定。在附图中：

图1是实施例中异构API适配处理方法的流程图；

图2是实施例中另一种异构API适配处理方法的流程图；

图3是实施例中异构API适配处理方法的一个具体化流程图；

图4是实施例中异构API适配处理系统的结构图；

图5是实施例中另一种异构API适配处理系统的结构图。

具体实施方式

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

图1是实施例中异构API适配处理方法的流程图，此方法包括配置方法部分。

配置方法部分包括：

步骤1-1，获取用于至少一源API类型的参数信息和参数转换规则；获取至少一目标API类型的参数定义；

步骤1-2，根据源API类型的参数信息和参数转换规则以及目标API类型的参数定义生成从目标API类型至源API类型的API转换配置信息。

其中，

步骤1-1中，获取源API类型的参数信息和参数转换规则包括：提供与源API类型对应的第一交互配置界面，通过第一交互配置界面接收源API类型的参数信息和参数转换规则。

步骤1-1中，获取目标API类型的参数定义包括：提供与目标API类型对应的第二交互配置界面，通过第二交互配置界面接收目标API类型的参数定义。

源API类型可以是本领域涉及的常见的API基本类型，例如，REST类型(属于HTTP协议)、SOAP类型(属于HTTP协议)、TCP类型。针对不同的API类型，系统提供不同的交互配置界面，交互配置界面中包括相应API类型的基本信息。例如，针对REST接口类型，系统提供的交互配置界面中包括REST接口的输入输出参数(包括参数名称、类型、是否可选等属性)；针对SOAP接口类型，系统提供的交互配置界面中包括WSDL描述文件的定义；针对TCP接口类型，系统提供的交互配置界面中包括需由用户定义的报文格式以及每段数据代表的内容。

目标API类型的参数定义包括输入输出参数的名称、类型、取值范围等，以及请求返回的状态码。

为了让用户能高效、灵活地进行转换规则的配置，本发明提供了友好的交互配置界面便于用户以低代码的方式配置API转换规则，系统提供了多种参数配置方式。针对简单的参数映射(不同位置、不同参数名之间的映射)，交互配置界面提供图形化参数映射的选择方式。例如：一源API中一主参数需设置对应的子参数时，界面中列出此主参数对应的多个子参数，用户可以在子参数列表中选择出至少一个子参数作为选择的结果。

针对包含复杂的转换逻辑的场景(转换参数内容、生成新的参数内容)，本方法提供了基于JavaScript实现的参数转换语言，用于对源API参数进行处理，并生成新参数。例如，源接口返回的数据为订单列表{“orders”:[{“id”:1,“amount”:123},{“id”:1,“amount”:22},{“id”:2,“amount”:23}]}，转换后的接口数据需要按每个order对象中的id属性进行聚合，聚合后的结果是{“amounts_by_oder”:{1:[123,22,23],2:[23]}}。即在需要进行参数逻辑转换时，则可以使用参数转换语言通过编码的方式实现转换。

本方法还包括：根据目标API类型的参数定义，基于swagger框架生成API文档。使用系统的API测试平台(类似Postman)在线测试生成的API，此处的主要作用是方便开发人员快速理解API的调用方式，以便进行二次开发。

如图2所示，异构API适配处理方法还包括执行方法，执行方法包括：

步骤2-1，接收API调用请求；

步骤2-2，确定API调用请求的目标API类型作为第一API类型，确定API调用请求的源API类型称为第二API类型；

步骤2-3，从已生成的API转换配置信息中查找并加载从第一API类型至第二API类型的API转换配置信息；

步骤2-4，根据查找到的API转换配置信息进行API调用请求的转换；

步骤2-5，发送转换后的符合第二API类型的API调用请求。

配置方法部分还包括将生成的API转换配置信息存储于数据库(MySQL)中，执行方法中在需要执行API转换时，从数据库中获取所需的API转换配置信息。

配置方法部分还包括：步骤1-3，设置与源API类型对应的适配器；适配器用于接收API转换配置信息和API请求，将此API请求从API转换配置信息中的第一API类型的请求体转换为API转换配置信息中的第二API类型的请求体，还用于将源API的返回信息转换为目标API所支持格式的返回信息。

执行方法的步骤2-4中根据查找到的API转换配置信息进行API调用请求的转换包括：使用与第一API类型对应的适配器将API调用请求转换为符合第二API类型请求体的请求。执行方法的步骤2-6，接收源API的返回信息，将源API的返回信息转换为目标API所支持格式的返回信息并发送至API请求的发送方。本方法中，向源API发送符合第二API类型请求体的请求时，经由代理模块(基于Nginx实现)发送，接收源API的返回信息时，也经由此代理模块接收。

为了保证API请求的顺利转换，步骤2-3和步骤2-4之间还包括：根据第一API类型的参数定义验证API调用请求中的参数是否符合定义要求。

图3是异构API适配处理方法的一个具体化的流程图，是在图2所示方法的基础上结合上述细节处理方法的流程图。

如图4所示，异构API适配系统包括配置模块。

配置模块包括：

源API信息获取模块，用于获取用于至少一源API类型的参数信息和参数转换规则；

目标API信息获取模块，用于获取至少一目标API类型的参数定义；

配置信息生成模块，用于根据源API类型的参数信息和参数转换规则以及目标API类型的参数定义生成从目标API类型至源API类型的API转换配置信息。

其中，

源API信息获取模块包括：

第一交互单元，用于提供与源API类型对应的第一交互配置界面；

第一接收单元，用于通过第一交互配置界面接收源API类型的参数信息和参数转换规则；

源API信息获取模块包括：

第二交互单元，用于提供与目标API类型对应的第二交互配置界面；

第二接收单元，用于通过第二交互配置界面接收目标API类型的参数定义。

如图5所示，此系统还包括执行模块，具体包括：

接收模块，用于接收API调用请求；

确定模块，用于确定API调用请求的目标API类型作为第一API类型，确定API调用请求的源API类型称为第二API类型；

加载模块，用于从已生成的API转换配置信息中查找并加载从第一API类型至第二API类型的API转换配置信息；

转换模块，用于根据查找到的API转换配置信息进行API调用请求的转换；

发送模块，用于发送转换后的符合第二API类型的API调用请求。

进一步地，

配置模块还包括：适配器设置模块，用于设置与源API类型对应的适配器；适配器用于接收API转换配置信息和API请求，将此API请求从API转换配置信息中的第一API类型的请求体转换为API转换配置信息中的第二API类型的请求体；

转换模块，还用于使用与第一API类型对应的适配器将API调用请求转换为符合第二API类型请求体的请求。

为了保证API请求的顺利转换，加载模块和执行模块之间还包括验证模块，用于根据第一API类型的参数定义验证API调用请求中的参数是否符合定义要求。

下面结合图2通过一个具体实施例说明本发明。

源API类型为SOAP类型，设置源API类型的参数信息和参数转换规则。

参数信息包括：

1、地址信息：具体为SOAP接口地址，例如：

http://webservices.oorsprong.org/websamples.countryinfo/ CountryInfoService.wso

2、输入消息体格式：具体为XML格式，例如：

其中，源API的消息体中包括一重要参数sCountryISOCode。

3、消息返回格式为XML格式，具体如下：

目标API类型为REST格式。设置目标API类型的参数定义，包括：

1、配置目标API的querystring位置的参数sCountryISOCode。

2、输入参数的转换规则，例如：

转换规则中<％＝$request.query("sCountryISOCode")％>部分是将目标API中的sCountryISOCode参数映射到源API请求体需要的请求参数中，重新组合成XML格式的数据。

除了上述设置外，还设置了输出消息体转换规则，将源API返回的XML转换成JSON数据。转换规则如下：<％＝$util.jsonEncode($response.body)％>，其含义是将源API返回的Body进行JSON编码。

HTTP服务器从客户端接收到目标API请求后，确定目标API类型和源API类型，从MySQL服务器获取从目标API类型至源API类型的转换配置信息并加载，验证目标API类型的参数位于正确范围后，通过相应的适配器转换为源API类型的请求，将此请求发送至代理模块，由代理模块发送至源API，从源API接收其返回的信息，适配器将返回的信息转换为目标API类型支持的格式后发送至HTTP服务器，HTTP服务器将收到的信息转发至客户端。

本发明可以方便进行不同API类型的API请求转换。本发明具备极强的扩展能力，对于系统不支持的API类型，只需开发相应的适配器，以及设计新类型API的转换规则即可。本发明还为用户提供配置界面，使用户可方便的进行参数配置，提高用户使用体验，并且便于进一步的管理和使用。

上面描述的内容可以单独地或者以各种方式组合起来实施，而这些变型方式都在本发明的保护范围之内。

本领域普通技术人员可以理解上述方法中的全部或部分步骤可通过程序来指令相关硬件完成，所述程序可以存储于计算机可读存储介质中，如只读存储器、磁盘或光盘等。可选地，上述实施例的全部或部分步骤也可以使用一个或多个集成电路来实现，相应地，上述实施例中的各模块/单元可以采用硬件的形式实现，也可以采用软件功能模块的形式实现。本发明不限制于任何特定形式的硬件和软件的结合。

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

以上实施例仅用以说明本发明的技术方案而非限制，仅仅参照较佳实施例对本发明进行了详细说明。本领域的普通技术人员应当理解，可以对本发明的技术方案进行修改或者等同替换，而不脱离本发明技术方案的精神和范围，均应涵盖在本发明的权利要求范围当中。

Claims (12)

1.一种异构API适配处理方法，其特征在于，包括配置方法，所述配置方法包括：

获取用于至少一源API类型的参数信息和参数转换规则；获取至少一目标API类型的参数定义；根据所述源API类型的参数信息和参数转换规则以及所述目标API类型的参数定义生成从所述目标API类型至所述源API类型的API转换配置信息。

2.如权利要求1所述的异构API适配处理方法，其特征在于，

所述获取源API类型的参数信息和参数转换规则包括：提供与源API类型对应的第一交互配置界面，通过所述第一交互配置界面接收所述源API类型的参数信息和参数转换规则；

所述获取目标API类型的参数定义包括：提供与目标API类型对应的第二交互配置界面，通过所述第二交互配置界面接收所述目标API类型的参数定义。

3.如权利要求1所述的异构API适配处理方法，其特征在于，

所述执行方法包括：

接收API调用请求，确定所述API调用请求的目标API类型作为第一API类型，确定所述API调用请求的源API类型称为第二API类型，从已生成的API转换配置信息中查找并加载从所述第一API类型至所述第二API类型的API转换配置信息，根据查找到的API转换配置信息进行API调用请求的转换，发送转换后的符合第二API类型的API调用请求。

4.如权利要求3所述的异构API适配处理方法，其特征在于，

所述配置方法还包括：设置与所述源API类型对应的适配器；所述适配器用于接收API转换配置信息和API请求，将此API请求从所述API转换配置信息中的第一API类型的请求体转换为所述API转换配置信息中的第二API类型的请求体；

所述根据查找到的API转换配置信息进行API调用请求的转换包括：使用与所述第一API类型对应的适配器将所述API调用请求转换为符合第二API类型请求体的请求。

5.如权利要求3所述的异构API适配处理方法，其特征在于，

所述从已生成的API转换配置信息中查找并加载从所述第一API类型至所述第二API类型的API转换配置信息后，所述方法还包括：根据第一API类型的参数定义验证所述API调用请求中的参数是否符合定义要求。

6.如权利要求3所述的异构API适配处理方法，其特征在于，

所述根据查找到的API转换配置信息进行API调用请求的转换包括：使用参数转换语言通过编码的方式实现转换，具体包括：在需要进行参数逻辑转换时，使用参数转换语言通过编码的方式实现转换。

7.一种异构API适配处理系统，其特征在于，包括配置模块；

所述配置模块包括：

源API信息获取模块，用于获取用于至少一源API类型的参数信息和参数转换规则；

目标API信息获取模块，用于获取至少一目标API类型的参数定义；

配置信息生成模块，用于根据所述源API类型的参数信息和参数转换规则以及所述目标API类型的参数定义生成从所述目标API类型至所述源API类型的API转换配置信息。

8.如权利要求7所述的异构API适配处理系统，其特征在于，

所述源API信息获取模块包括：

第一交互单元，用于提供与源API类型对应的第一交互配置界面；

第一接收单元，用于通过所述第一交互配置界面接收所述源API类型的参数信息和参数转换规则；

所述源API信息获取模块包括：

第二交互单元，用于提供与目标API类型对应的第二交互配置界面；

第二接收单元，用于通过所述第二交互配置界面接收所述目标API类型的参数定义。

9.如权利要求7所述的异构API适配处理系统，其特征在于，

所述系统还包括执行模块，所述执行模块包括：

接收模块，用于接收API调用请求；

确定模块，用于确定所述API调用请求的目标API类型作为第一API类型，确定所述API调用请求的源API类型称为第二API类型；

加载模块，用于从已生成的API转换配置信息中查找并加载从所述第一API类型至所述第二API类型的API转换配置信息；

转换模块，用于根据查找到的API转换配置信息进行API调用请求的转换；

发送模块，用于发送转换后的符合第二API类型的API调用请求。

10.如权利要求9所述的异构API适配处理系统，其特征在于，

所述配置模块还包括：

适配器设置模块，用于设置与所述源API类型对应的适配器；所述适配器用于接收API转换配置信息和API请求，将此API请求从所述API转换配置信息中的第一API类型的请求体转换为所述API转换配置信息中的第二API类型的请求体；

所述转换模块，还用于使用与所述第一API类型对应的适配器将所述API调用请求转换为符合第二API类型请求体的请求。

11.如权利要求9所述的异构API适配处理系统，其特征在于，

所述加载模块和执行模块之间还包括验证模块，用于根据第一API类型的参数定义验证所述API调用请求中的参数是否符合定义要求。

12.如权利要求9所述的异构API适配处理系统，其特征在于，

所述转换模块，还用于在需要进行参数逻辑转换时，使用参数转换语言通过编码的方式实现转换。