CN113703862A

CN113703862A - 基于配置的接口调用方法、装置、设备及存储介质

Info

Publication number: CN113703862A
Application number: CN202110783169.9A
Authority: CN
Inventors: 宋仕嘉
Original assignee: New H3C Big Data Technologies Co Ltd
Current assignee: New H3C Big Data Technologies Co Ltd
Priority date: 2021-07-12
Filing date: 2021-07-12
Publication date: 2021-11-26

Abstract

本公开提供了一种基于配置的接口调用方法、装置、设备及存储介质，用于解决接口对接和使用效率低的技术问题。本公开将本地业务代码与第三方接口的调用代码通过定制的接口配置文件解耦，根据接口配置文件配置的请求方法、请求路径和请求参数构造接口调用请求，根据接口配置文件中配置的目标字段的对应关系从结果响应数据中解析和提取所需要的目标字段的结果数据，减少了重复代码的编写，提高了各厂商之间基于接口的能力的对接和使用效率。

Description

基于配置的接口调用方法、装置、设备及存储介质

技术领域

本公开涉及云计算技术领域，尤其涉及一种基于配置的接口调用方法、装置、设备及存储介质。

背景技术

目前云计算越来越普及，众多厂商通过REST API(Representational StateTransfer Application Interface，表现层状态转换应用程序接口)提供了丰富的云能力，但各厂商针对平台、***和应用提供的REST API千差万别，各种REST API接口的调用方法、数据解析方式等都不一样，若要整合不同厂商的云能力，需要通过编写不同的代码来访问各个厂商、***的REST API，对每一个厂商提供的REST API的数据处理都需通过在代码中硬编码的方式来解析，对不同厂商不同的REST API需要编写大量的代码来处理，甚至对于同一个厂商REST API的不同版本都需要编写不同的代码来处理，这样的方式费时费力且易出错。另外，由于REST API的调用和数据的处理是硬编码在代码中，使得REST API的任何微小的变化，都可能导致需要重新编写代码、重新编译调试。上述技术缺陷，导致各家厂商的云能力无法实现高效的对接和使用。

发明内容

有鉴于此，本公开提供一种基于配置的接口调用方法、装置、设备及存储介质，用于解决接口对接和使用效率低的技术问题。

基于本公开实施例的一方面，本公开提供了一种基于配置的接口调用方法，该方法基于接口配置文件实现对第三方接口的调用和解析，该方法包括：

读取和解析接口配置文件和接口参数文件；所述接口配置文件中配置了调用第三方接口的请求方法、请求路径、请求参数，以及本地目标字段与第三方接口的响应结果数据中目标字段的对应关系；所述接口参数文件用于为接口配置文件中配置的请求参数提供参数值；

基于接口配置文件配置的请求路径、请求参数构造调用所述第三方接口的URL，构造接口的请求体；基于所构造的调用所述第三方接口的URL、接口配置文件配置的接口请求方法、所构造的请求体生成和发起所述第三方接口的接口调用请求；

接收到所述第三方接口返回的响应结果数据后，根据接口配置文件中配置的本地目标字段与第三方接口的响应结果数据中目标字段的对应关系，将响应结果数据中的目标字段的值赋值给本地目标字段。

进一步地，所述请求体的构造方式基于接口配置文件中的配置进行。

进一步地，所述第三方接口为表现层状态转换应用程序接口REST API接口。

进一步地，所述接口配置文件和接口参数文件采用JSON格式。

基于本公开实施例的另一方面，本公开还提供一种基于配置的接口调用装置，该装置基于接口配置文件实现对第三方接口的调用和解析，该装置包括：

配置文件解析模块，用于读取和解析接口配置文件和接口参数文件；所述接口配置文件中配置了调用第三方接口的请求方法、请求路径、请求参数，以及本地目标字段与第三方接口的响应结果数据中目标字段的对应关系；所述接口参数文件用于为接口配置文件中配置的请求参数提供参数值；

接口调用模块，用于基于接口配置文件配置的请求路径、请求参数构造调用所述第三方接口的URL，构造接口的请求体；基于所构造的调用所述第三方接口的URL、接口配置文件配置的接口请求方法、所构造的请求体生成和发起所述第三方接口的接口调用请求；

结果数据提取模块，用于接收到所述第三方接口返回的响应结果数据后，根据接口配置文件中配置的本地目标字段与第三方接口的响应结果数据中目标字段的对应关系，将响应结果数据中的目标字段的值赋值给本地目标字段。

基于本公开另一实施例，所述接口调用模块基于接口配置文件中的配置构造所述请求体。

基于本公开另一实施例，所述第三方接口为表现层状态转换应用程序接口RESTAPI接口。

基于本公开另一实施例，所述接口配置文件和接口参数文件采用JSON格式。

附图说明

为了更加清楚地说明本公开实施例或者现有技术中的技术方案，下面将对本公开实施例或者现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本公开中记载的一些实施例，对于本领域普通技术人员来讲，还可以根据本公开实施例的这些附图获得其他的附图。

图1为本公开实施例提供的一种基于配置的接口调用方法步骤流程图；

图2为本公开一实施例提供的一种装置结构示意图；

图3为本公开一实施例提供的实现基于配置的接口调用方法的电子设备结构示意图。

具体实施方式

在本公开实施例使用的术语仅仅是出于描述特定实施例的目的，而非限制本公开实施例。本公开实施例中所使用的单数形式的“一种”、“所述”和“该”也旨在包括多数形式，除非上下文清楚地表示其它含义。本公开中使用的术语“和/或”是指包含一个或多个相关联的列出项目的任何或所有可能组合。

应当理解，尽管在本公开实施例可能采用术语第一、第二、第三等来描述各种信息，但这些信息不应限于这些术语。这些术语仅用来将同一类型的信息彼此区分开。例如，在不脱离本公开实施例范围的情况下，第一信息也可以被称为第二信息，类似地，第二信息也可以被称为第一信息。取决于语境，此外，所使用的词语“如果”可以被解释成为“在……时”或“当……时”或“响应于确定”。

本公开旨在提供一种基于配置的接口调用方法，目的是实现通过单一、稳定的处理框架访问任意REST API并完成数据处理，不再需要针对不同的厂商***开发不同的代码，保证了软件项目稳定、高效交付。

图1为本公开实施例提供的一种基于配置的接口调用方法步骤流程图，该方法基于接口配置文件实现对第三方接口的调用和解析，包括以下步骤：

S101、读取和解析接口配置文件和接口参数文件；所述接口配置文件中配置了调用第三方接口的请求方法、请求路径、请求参数，以及本地目标字段与第三方接口的响应结果数据中目标字段的对应关系；所述接口参数文件用于为接口配置文件中配置的请求参数提供参数值；

S102、基于接口配置文件配置的请求路径、请求参数构造调用所述第三方接口的URL，构造接口的请求体；基于所构造的调用所述第三方接口的URL、接口配置文件配置的接口请求方法、所构造的请求体生成和发起所述第三方接口的接口调用请求；

S103、接收到所述第三方接口返回的响应结果数据后，根据接口配置文件中配置的本地目标字段与第三方接口的响应结果数据中目标字段的对应关系，将响应结果数据中的目标字段的值赋值给本地目标字段。

多个不同第三方接口对应不同的接口配置文件和接口参数文件。对于不同的第三方接口，只需要编写与之适配的接口配置文件，而不再需要修改本地业务代码等。

本公开提供了一种基于配置文件的统一的第三方接口的调用和数据转换框架，该框架可采用spring boot、flask、tornado、play等任意的web开发工具实现。该框架可将本地业务代码与第三方接口的调用代码通过定制的接口配置文件解耦，根据接口配置文件配置的请求方法、请求路径和请求参数构造接口调用请求，根据接口配置文件中配置的目标字段的对应关系从结果响应数据中解析和提取所需要的目标字段的结果数据，减少了重复代码的编写，提高了各厂商之间基于接口的对接和使用效率。

以下以某云厂商提供的查询一台或多台弹性计算服务(Elastic ComputeService，ECS)实例的详细信息的REST API接口DescribeInstances为例，说明具体的实现过程：

S201、从接口提供方获取接口使用说明；

通常可从接口提供厂商的官网获取到接口的使用说明，例如对DescribeInstances接口的说明中可以提取到的信息包括：请求方法、接口请求路径等；地址即接口的统一资源定位符URL等。

提供方给出的DescribeInstances的调用示例如下：

https://ecs.xxx.com/？Action＝DescribeInstances&RegionId＝cn-hangzhou&PageSize＝1PageNumber＝1。

通过接口说明可知，该接口的请求方法为Get，接口必须的请求参数如表1所示，示例中的PageSize和PageNumber为可选的页尺寸和页号参数：

表1

在调用该DescribeInstances接口后，接口返回的JSON格式的响应结果数据示例如下：

其中，“Instances”标签中可包括接口响应的接口请求中区域标识RegionId指定的区域内的多个实例的“Instance”标签，“Instance”标签内部包括了服务实例的各种属性。

S202、基于接口提供方的接口说明，建立与接口DescribeInstances配套的JSON格式的接口配置文件；

本公开一实施例采用JSON格式来生成接口配置文件，JSON(JavaScript ObjectNotation)是基于ECMAScript(欧洲计算机协会制定的JS规范)的一个子集，采用完全与编程语言无关的文本形式来存储和表示数据，是一种简洁高效的数据表示和交换形式。JSON本身简洁和清晰的层次结构，易于人理解、阅读、编写和使用,同时也易于各种计算机平台、计算机语言解析和生成。

基于前述的API接口描述，建立DescribeInstances接口的接口配置文件，示例如下：

其中，“api”为标识API接口配置的标签；“method”标签用于配置请求方法；“url”标签用于配置接口的请求路径；“request_parameters”标签用于配置调用接口的请求参数及参数类型；“response_base”标签用于配置在接口响应中的解析的标签位置；“response_parser”标签用于配置接口响应数据的转换方法，其中包含了本地目标字段名与接口响应结果数据中的目标字段名的对应关系，例如本地目标字段“id”对应接口响应数据中目标字段“InstanceId”标签的内容。

S203、在调用DescribeInstances接口前，根据接口配置文件中指定的参数及参数类型生成DescribeInstances接口的接口参数文件，接口参数文件用于为接口配置文件中指定的请求参数提供参数值；

S203、从DescribeInstances接口的接口配置文件中读取接口请求方法、请求路径、请求参数，并从DescribeInstances接口的接口参数文件读取请求参数的参数值；

S204、基于从DescribeInstances接口的接口配置文件中读取的请求路径、请求参数构造出完整的调用DescribeInstances接口的统一资源定位符URL；

S205、构造DescribeInstances接口的请求体，基于调用接口的URL、接口请求方法、请求体生成和发起DescribeInstances接口的接口调用请求。

本公开提供统一的REST API接口处理框架，在处理框架内解析DescribeInstances接口的接口配置文件，获取所需要调用的REST API接口的信息，包括请求方法(api.method)、请求路径(api.url)、请求参数(api.request_parameters)等，框架再将这些信息用于发起REST API接口调用请求的参数，最终发起正确的接口调用请求。

以下示例中，invokeCommonRestAPI函数基于DescribeInstances接口配置文件和接口参数文件构造DescribeInstances接口调用请求，invokeCommonRestAPI函数的返回值即为调用接口后的接口响应数据：

其中，ObjectMapper对象用于读取合法JSON字符串，转换成JsonNode对象。JsonNode是Java中表示JSON的类，由ObjectMapper从apiConfig指定的接口配置文件中的“api”标签内的内容来构造JsonNode对象。ObjectMapper根据apiValue指定的接口参数文件构造读取接口参数文件内容的Json对象。从接口配置文件和接口参数文件中读取读取出接口参数和参数值后，与请求路径拼接出完整的调用接口的URL即示例中的aip_url。最终，通过exchange函数基于调用接口的URL即aip_url、接口请求方法httpMethod、请求体httpEntity等参数生成和发起DescribeInstances接口的接口调用请求，exchange函数的返回结果即为接口响应数据。

其中，请求体httpEntity的构造方式可在接口配置文件中配置。例如，根据不同的第三方接口的接口说明，在接口配置文件中配置构造请求体的关键配置信息，例如"Content-Type"、"Accept"等标签内容。

S206、接收DescribeInstances接口返回的响应结果数据后，读取接口配置文件中配置的本地目标字段与第三方接口的响应结果数据中目标字段的对应关系，根据所述对应关系将响应结果数据中的目标字段的值赋值给本地目标字段。

基于DescribeInstances接口的接口配置文件解析响应结果数据，将DescribeInstances接口返回的响应结果数据转换成本地规范、统一的形式，完成数据处理的示例如下：

其中，commonResponseParser函数的输入参数apiConfig为DescribeInstances接口的接口配置文件，responseValue参数为调用DescribeInstances接口后接口返回的响应结果数据文件。接口配置文件中的"response_base"标签指定了包含响应结果数据的标签"Instances.Instance"。接口配置文件中的"response_parser"标签指示了需从接口响应结果数据中解析的目标字段，以及本地目标字段名与接口响应结果数据中的目标字段的对应关系。

commonResponseParser函数将接口响应结果数据读取到basedValue对象中，从接口配置文件中读取需要解析的参数生成responseParser对象，然后从basedValue中读取出responseParser中的目标字段的值，将读取的目标字段结果存入result对象中，result对象中包含的键值对(Key-Value)中的Key为本地统一命名的目标字段名，Value为响应结果数据中与本地目标字段对应的返回值。

例如，DescribeInstances接口的接口配置文件中"response_parser"标签中包括一项配置为"name:InstanceName:String"，含义为本地目标字段“name”对应接口响应结果数据中的目标字段“InstanceName”，目标字段类型为字符串String类型，本地目标字段名“name”为处理框架规定的本端统一的属性名，InstanceName为接口提供方的属性名。最终commonResponseParser函数会将“name”作为Key，将响应结果数据中“InstanceName”的标签值作为Value，写入到result对象中，最终result中将包含所有"response_parser"标签设置的所有本地目标字段的键值对。

上述实施例，基于JSON配置文件，将与第三方提供的接口对接的部分分离出来，通过接口配置文件配置接口调用方法，建立本地统一的目标字段与接口提供方的目标字段之间的对应关系，可避免将接口调用的代码硬编码到业务代码中，能够实现稳定健壮地API接口调用及解析，在接口版本发生变化时，不需要修改业务代码，仅需要更新JSON配置文件即可，为各种需要访问多个第三方提供的API接口的平台、软件、工具的开发带来便利，减少了重复代码的编写，提高了各厂商之间基于API接口的云能力的高效对接和使用。

图2为本公开一实施例提供的一种基于配置的接口调用装置结构示意图，该装置200中的各功能模块可以采用软件、硬件或软硬件相结合的方式实现。本公开还提供一种基于配置的接口调用装置，该装置200基于接口配置文件实现对第三方接口的调用和解析，该装置200包括：

配置文件解析模块201，用于读取和解析接口配置文件和接口参数文件；所述接口配置文件中配置了调用第三方接口的请求方法、请求路径、请求参数，以及本地目标字段与第三方接口的响应结果数据中目标字段的对应关系；所述接口参数文件用于为接口配置文件中配置的请求参数提供参数值；

接口调用模块202，用于基于接口配置文件配置的请求路径、请求参数构造调用所述第三方接口的URL，构造接口的请求体；基于所构造的调用所述第三方接口的URL、接口配置文件配置的接口请求方法、所构造的请求体生成和发起所述第三方接口的接口调用请求；

结果数据提取模块203，用于接收到所述第三方接口返回的响应结果数据后，根据接口配置文件中配置的本地目标字段与第三方接口的响应结果数据中目标字段的对应关系，将响应结果数据中的目标字段的值赋值给本地目标字段。

进一步地，第三方接口为表现层状态转换应用程序接口REST API接口。接口配置文件和接口参数文件采用JSON格式。

本公开另一实施例中，接口调用模块202基于接口配置文件中的配置构造所述请求体。

图3为本公开一实施例提供的实现基于配置的接口调用方法的电子设备结构示意图，该设备300包括：诸如中央处理单元(CPU)的处理器310、通信总线320、通信接口340以及存储介质330。其中，处理器310与存储介质330可以通过通信总线320相互通信。存储介质330内存储有计算机程序，当该计算机程序被处理器310执行时即可实现本公开提供的方法的各步骤的功能。

其中，存储介质可以包括随机存取存储器(Random Access Memory，RAM)，也可以包括非易失性存储器(Non-Volatile Memory，NVM)，例如至少一个磁盘存储器。另外，存储介质还可以是至少一个位于远离前述处理器的存储装置。处理器可以是通用处理器，包括中央处理器(Central Processing Unit，CPU)、网络处理器(Network Processor，NP)等；还可以是数字信号处理器(Digital Signal Processing，DSP)、专用集成电路(ApplicationSpecific Integrated Circuit，ASIC)、现场可编程门阵列(Field-Programmable GateArray，FPGA)或其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件。

应当认识到，本公开的实施例可以由计算机硬件、硬件和软件的组合、或者通过存储在非暂时性存储器中的计算机指令来实现或实施。所述方法可以使用标准编程技术，包括配置有计算机程序的非暂时性存储介质在计算机程序中实现，其中如此配置的存储介质使得计算机以特定和预定义的方式操作。每个程序可以以高级过程或面向对象的编程语言来实现以与计算机***通信。然而，若需要，该程序可以以汇编或机器语言实现。在任何情况下，该语言可以是编译或解释的语言。此外，为此目的该程序能够在编程的专用集成电路上运行。此外，可按任何合适的顺序来执行本公开描述的过程的操作，除非本公开另外指示或以其他方式明显地与上下文矛盾。本公开描述的过程(或变型和/或其组合)可在配置有可执行指令的一个或多个计算机***的控制下执行，并且可作为共同地在一个或多个处理器上执行的代码(例如，可执行指令、一个或多个计算机程序或一个或多个应用)、由硬件或其组合来实现。所述计算机程序包括可由一个或多个处理器执行的多个指令。

进一步，所述方法可以在可操作地连接至合适的任何类型的计算平台中实现，包括但不限于个人电脑、迷你计算机、主框架、工作站、网络或分布式计算环境、单独的或集成的计算机平台、或者与带电粒子工具或其它成像装置通信等等。本公开的各方面可以以存储在非暂时性存储介质或设备上的机器可读代码来实现，无论是可移动的还是集成至计算平台，如硬盘、光学读取和/或写入存储介质、RAM、ROM等，使得其可由可编程计算机读取，当存储介质或设备由计算机读取时可用于配置和操作计算机以执行在此所描述的过程。此外，机器可读代码，或其部分可以通过有线或无线网络传输。当此类媒体包括结合微处理器或其他数据处理器实现上文所述步骤的指令或程序时，本公开所述的发明包括这些和其他不同类型的非暂时性计算机可读存储介质。当根据本公开所述的方法和技术编程时，本公开还包括计算机本身。

以上所述仅为本公开的实施例而已，并不用于限制本公开。对于本领域技术人员来说，本公开可以有各种更改和变化。凡在本公开的精神和原理之内所作的任何修改、等同替换、改进等，均应包含在本公开的保护范围之内。

Claims

1.一种基于配置的接口调用方法，其特征在于，该方法基于接口配置文件实现对第三方接口的调用和解析，该方法包括：

2.根据权利要求1所述的方法，其特征在于，

所述请求体的构造方式基于接口配置文件中的配置进行。

3.根据权利要求1所述的方法，其特征在于，

所述第三方接口为表现层状态转换应用程序接口REST API接口。

4.根据权利要求1所述的方法，其特征在于，

所述接口配置文件和接口参数文件采用JSON格式。

5.一种基于配置的接口调用装置，其特征在于，该装置基于接口配置文件实现对第三方接口的调用和解析，该装置包括：

6.根据权利要求5所述的装置，其特征在于，

所述接口调用模块基于接口配置文件中的配置构造所述请求体。

7.根据权利要求5所述的装置，其特征在于，

8.根据权利要求5所述的装置，其特征在于，

所述接口配置文件和接口参数文件采用JSON格式。

9.一种电子设备，其特征在于，包括处理器、通信接口、存储介质和通信总线，其中，处理器、通信接口、存储介质通过通信总线完成相互间的通信；

存储介质，用于存放计算机程序；

处理器，用于执行存储介质上所存放的计算机程序时，实施权利要求1-4任一项所述的方法步骤。

10.一种存储介质，其上存储有计算机程序，其特征在于，所述计算机程序当被处理器执行时实施如权利要求1至4中任一项所述的方法步骤。