CN115509647B

CN115509647B - Api接口访问方法、转换方法、装置、设备及存储介质

Info

Publication number: CN115509647B
Application number: CN202211465527.2A
Authority: CN
Inventors: 徐霞; 杨健伟; 张社丽; 郭敏
Original assignee: Shenzhen Landray Software Co ltd
Current assignee: Shenzhen Landray Software Co ltd
Priority date: 2022-11-21
Filing date: 2022-11-21
Publication date: 2023-03-03
Anticipated expiration: 2042-11-21
Also published as: CN115509647A

Abstract

本申请实施例提供了API接口访问方法、转换方法、装置、设备及存储介质，属于信息技术领域。本申请实施例与相关技术相比，通过对Web Service接口请求信息的解析，并根据待访问API接口的接口结构描述信息将Web Service接口请求信息转换为待访问API接口的访问请求，实现通过SOAP协议来访问REST业务接口，从而能够实现接口统一协议调用，进而有效降低接口提供方系统的开发和维护的工作量。

Description

API接口访问方法、转换方法、装置、设备及存储介质

技术领域

本申请涉及计算机技术领域，尤其涉及一种API接口访问方法、转换方法、装置、设备及存储介质。

背景技术

Web服务常用的接口协议有REST协议和SOAP协议。由于REST协议可以降低开发的复杂性，提高系统的可伸缩性，越来越多的Web服务开始采用REST协议设计和实现。目前，很多系统对外开放的API接口都是采用REST协议进行访问调用，但也存在很多第三方系统希望以SOAP协议去调用接口。

针对上述需求，相关技术中往往是同时写一套REST协议接口和一套SOAP协议接口，使得第三方系统可以分别调用。但是这种方式会增加系统开发和维护的工作量，从而增加系统成本。

发明内容

本申请实施例的主要目的在于提出一种API接口访问方法、转换方法、装置、设备及存储介质，能够使得第三方系统可以通过SOAP协议来调用REST接口。

为实现上述目的，本申请实施例的第一方面提出了一种API接口访问方法，所述方法包括：

获取Web Service接口请求；其中，所述Web Service接口请求为SOAP协议请求；

根据所述Web Service接口请求，获取待访问的API接口的接口信息；其中，所述API接口为REST协议接口；

根据所述接口信息，得到所述API接口对应的接口结构描述信息；

根据所述接口结构描述信息，将所述Web Service接口请求转换成REST请求；

发送所述REST请求到所述API接口。

在一些实施例中，所述Web Service接口请求包含XML请求报文，所述API接口的接口信息包括API接口类名和API实现类类名；

所述根据所述Web Service接口请求，获取待访问的API接口的接口信息，包括：

根据所述Web Service接口请求的XML请求报文，获取请求路径；

根据所述请求路径，获取所述API接口的API接口类名和API实现类类名；

所述根据所述接口信息，得到所述API接口对应的接口结构描述信息，包括：

根据所述API接口类名和API实现类类名，用Java反射机制，解析出所述API接口的对应的接口结构描述信息。

在一些实施例中，所述接口结构描述信息包括入参结构信息和出参结构信息；其中，所述入参结构信息包括入参方法信息和入参类型信息，所述出参结构信息包括出参方法信息和出参类型信息；

所述根据所述API接口类名和API实现类类名，用Java反射机制，解析出所述API接口的对应的接口结构描述信息，包括：

根据所述API接口类名，用Java反射机制获取对应的入参方法信息和出参方法信息；

根据所述API实现类类名和所述入参方法信息、出参方法信息，用Java反射机制获取对应的入参类型信息和出参类型信息；

根据所述入参类型信息和出参类型信息，形成所述接口结构描述信息。

在一些实施例中，所述根据所述接口结构描述信息，将所述Web Service接口请求转换成REST请求，包括：

解析所述XML请求报文，得到第一对象节点值；

根据所述接口结构描述信息，构建JSON对象；

将第一对象节点值对应存储到所述JSON对象，得到REST请求的主体信息；

根据所述主体信息，组装成所述REST请求。

在一些实施例中，所述解析所述XML请求报文，得到第一对象节点值，包括：

将所述XML请求报文转换成文档类数据，从所述文档类数据中获取主体信息；

根据第一遍历规则遍历所述文档类数据主体信息中的第一对象节点，获取得到多个第一对象节点对应的第一对象节点值；其中，所述第一遍历规则为逐层遍历或递归遍历，所述第一对象节点包括纯文本Element元素节点和对象类型Element元素节点。

在一些实施例中，所述获取Web Service接口请求之前，还包括：

监听已实现平台预设注解规则注解的API接口实例；

获取并存储监听到的所述API接口实例的请求路径、API接口类名和API实现类类名。

通过预设的WSDL描述获取接口，获取得到所述API接口的WSDL描述信息；

根据所述WSDL描述信息，组装得到所述Web Service接口请求。

在一些实施例中，所述API接口的WSDL描述信息由以下方式获取得到：

监听已实现平台预设注解规则注解的API接口实例；

获取并存储监听到的所述API接口实例的请求路径；

根据所述API接口实例的请求路径，得到所述API接口的接口信息；

根据所述接口结构描述信息和预设的目标格式模板，构建所述API接口的WSDL描述信息。

在一些实施例中，所述API接口的接口信息包括API接口类名；

所述根据所述API接口实例的请求路径，得到所述API接口的接口信息，包括：

识别所述API接口实例的请求路径，得到所述API接口类名；

在一些实施例中，所述根据所述接口结构描述信息和预设的目标格式模板，构建所述API接口的WSDL描述信息，包括：

遍历所述API接口的对应的接口结构描述信息，为WSDL基础元素节点赋值；其中，所述基础元素节点包括以下的至少一种：接口名、命名空间、调用路径；

根据所述接口结构描述信息对应的参数类型，构造WSDL类型节点；

根据所述接口结构描述信息对应的方法信息，构造生成对应的Element元素节点；

利用所述目标格式模板，将所述WSDL基础元素节点、WSDL类型节点、Element元素节点组装形成目标格式的WSDL描述信息；

其中，所述目标格式为XML格式。

在一些实施例中，所述发送所述REST请求到所述API接口之后，还包括：

获取来自所述API接口的JSON响应报文；

根据所述JSON响应报文，解析得到响应主体信息；

获取预设的XML响应报文模板；

根据所述响应主体信息和所述XML响应报文模板，组装得到XML响应报文；

将所述XML响应报文发送给Web Service请求方。

在一些实施例中，还包括：

获取所述API接口的访问策略；所述访问策略包括以下的至少一种：鉴权访问策略、限流访问策略、熔断策略；

当所述访问策略包括鉴权访问策略，所述根据所述Web Service接口请求，获取待访问的API接口的接口信息，包括：根据所述Web Service接口请求，获取待访问的API接口的接口信息和访问账号；根据所述访问账号和预设的账号权限对应关系，判断所述访问账号的访问权限；

当所述访问策略包括限流访问策略，所述根据所述Web Service接口请求，获取待访问的API接口的接口信息之后，包括：获取待访问的API接口的限流访问策略；根据限流访问策略，对所述API接口进行对应流量控制；

当所述访问策略包括熔断访问策略，所述根据所述Web Service接口请求，获取待访问的API接口的接口信息之后，包括：获取待访问的API接口的熔断访问策略；根据熔断访问策略，对所述API及接口进行对应熔断保护控制。

为实现上述目的，本申请实施例的第二方面提出了一种API接口描述转换方法，所述方法包括：监听已实现平台预设注解规则注解的API接口实例；所述API接口为REST协议接口；

获取并存储监听到的所述API接口实例的请求路径；

在一些实施例中，所述API接口的接口信息包括API接口类名；

识别所述API接口实例的请求路径，得到所述API接口类名；

其中，所述目标格式为XML格式。

为实现上述目的，本申请实施例的第三方面提出了一种API接口访问装置，包括：

第一模块，用于获取Web Service接口请求；其中，所述Web Service接口请求为SOAP协议请求；

第二模块，用于根据所述Web Service接口请求，获取待访问的API接口的接口信息；

第三模块，用于根据所述接口信息得到所述API接口对应的接口结构描述信息；

第四模块，用于根据所述接口结构描述信息，将所述Web Service接口请求转换成REST请求；

第五模块，用于发送所述REST请求到所述API接口。

为实现上述目的，本申请实施例的第四方面提出了一种电子设备，所述电子设备包括存储器和处理器，所述存储器存储有计算机程序，所述处理器执行所述计算机程序时实现上述第一方面实施例所述的API接口访问方法，或第二方面实施例所述的API接口描述转换方法。

为实现上述目的，本申请实施例的第五方面提出了一种存储介质，所述存储介质为计算机可读存储介质，所述存储介质存储有计算机程序，所述计算机程序被处理器执行时实现上述第一方面实施例所述的API接口访问方法，或第二方面实施例所述的API接口描述转换方法。

本申请实施例提出的API接口访问方法、转换方法、装置、设备及存储介质，至少具有如下有益效果：

本申请实施例第一方面提供的API接口访问方法，包括：获取Web Service接口请求，根据所述Web Service接口请求，获取待访问的API接口的接口信息，根据所述接口信息，得到所述API接口对应的接口结构描述信息，根据所述接口结构描述信息，将所述WebService接口请求转换成REST请求，发送所述REST请求到所述API接口。本申请实施例与相关技术相比，通过对Web Service接口请求信息的解析，并根据待访问API接口的接口结构描述信息将Web Service接口请求信息转换为待访问API接口的访问请求，实现通过SOAP协议来访问REST业务接口，从而能够实现接口统一协议调用，进而有效降低接口提供方系统的开发和维护的工作量。

本申请实施例第二方面提供的接口描述转换方法，包括：监听已实现平台预设注解规则注解的API接口实例，获取并存储监听到的所述API接口实例的请求路径，根据所述API接口实例的请求路径，得到所述API接口的接口信息，根据所述接口信息，得到所述API接口对应的接口结构描述信息，根据所述接口结构描述信息和预设的目标格式模板，构建所述API接口的WSDL描述信息。本申请实施例与相关技术相比，通过将API接口的接口描述转换为WSDL描述信息，以方便第三方查看，从而方便用户通过SOAP协议来访问REST业务接口。

可以理解的是，上述第三方面至第五方面与相关技术相比存在的有益效果与上述第一方面或第二方面与相关技术相比存在的有益效果相同，可以参见上述第一方面中的相关描述，在此不再赘述。

附图说明

图1是本申请实施例提供的API接口访问方法对应的系统架构示意图；

图2是本申请实施例提供的API接口访问方法的流程图；

图3是图2中的步骤S102至S103的流程图；

图4是图3中的步骤S203的流程图；

图5是图2中的步骤S104的流程图；

图6是图4中的步骤S401的流程图；

图7是图2中的步骤S101之前的流程图；

图8是本申请实施例提供的Open API接口设计流程图；

图9是本申请实施例提供的Open API接口注册流程图；

图10是本申请实施例提供的平台服务器API服务界面示意图；

图11是本申请实施例提供的平台服务器账号管理界面示意图；

图12是本申请实施例提供的平台服务器授权管理界面示意图；

图13是图2中的步骤S101之前的另一个流程图；

图14是图8中的步骤S701的流程图；

图15是图9中的步骤S805的流程图；

图16是本申请实施例提供的构造WSDL描述流程图；

图17是图2中的步骤S105之后的流程图；

图18是本申请实施例提供的API接口访问流程图；

图19是本申请实施例提供的API接口访问装置功能模块示意图；

图20是本申请实施例提供的电子设备的硬件结构示意图。

附图标记：Web Service请求方 110、平台服务器 120、第一模块 121、第二模块122、第三模块 123、第四模块 124、第五模块 125、接口提供方 130、电子设备 140、处理器141、存储器 142、输入/输出接口 143、通信接口 144、总线 145。

具体实施方式

为了使本申请的目的、技术方案及优点更加清楚明白，以下结合附图及实施例，对本申请进行进一步详细说明。应当理解，此处所描述的具体实施例仅用以解释本申请，并不用于限定本申请。

需要说明的是，虽然在装置示意图中进行了功能模块划分，在流程图中示出了逻辑顺序，但是在某些情况下，可以以不同于装置中的模块划分，或流程图中的顺序执行所示出或描述的步骤。说明书和权利要求书及上述附图中的术语“第一”、“第二”等是用于区别类似的对象，而不必用于描述特定的顺序或先后次序。

除非另有定义，本文所使用的所有的技术和科学术语与属于本申请的技术领域的技术人员通常理解的含义相同。本文中所使用的术语只是为了描述本申请实施例的目的，不是旨在限制本申请。

为了更好地理解本申请提供的技术方案，在此对本文中出现的术语进行相应地说明：

SOAP：简单对象访问协议（Simple Object Access Protocol），是交换数据的一种协议规范，是一种轻量的、简单的、基于XML的协议，它被设计成在Web上交换结构化的和固化的信息。

REST：表征状态转移（Representational State Transfer），一种软件架构风格。如果一个架构符合REST的约束条件和原则，则称其为RESTful架构。

API：应用程序接口（Application Program Interface），是指预先定义的函数，以提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。Open API即开放API，以供第三方开发者使用。

Open API:开放平台。指软件系统通过公开其应用程序编程接口（API）或函数（function)来使外部的程序可以增加该软件系统的功能或使用该软件系统的资源，而不需要更改该软件系统的源代码。

XML：可扩展标记语言（eXtensible Markup Language），标准通用标记语言的子集，可以用来标记数据、定义数据类型，是一种允许用户对自己的标记语言进行定义的源语言。

JSON：JavaScript对象表示法（JavaScript Object Notation），是一种轻量级的数据交换格式，JSON是存储和交换文本信息的语法，类似XML。

WSDL：网络服务描述语言（Web Services Description Language），是一门基于XML的语言，用于描述Web Services以及如何对它们进行访问。

Web Services：即Web服务，是一个平台独立的，低耦合的，自包含的、基于可编程的Web的应用程序，可使用开放的XML标准来描述、发布、发现、协调和配置这些应用程序，用于开发分布式的交互操作的应用程序。

Json Schema：用来对现有的JSON数据格式进行描述（字段类型、内容长度、是否必须存在、取值示例等）。

反射机制：在Java程序运行状态中，对于任何一个类，都可以获得这个类的所有属性和方法；对于给定的一个对象，都能够调用它的任意一个属性和方法。这种动态获取类的内容以及动态调用对象的方法称为反射机制。

Web服务API的早期标准是SOAP，其本质提供的是异构化接口，即使有WSDL作为描述文档，也没有改变“服务异构化API”这个事实。所以基于SOAP的服务五花八门，不利于网络时代的通用共享的需求，而REST就是通用需求下的产物。REST使用了标准HTTP，因此它相对于SOAP更加简单，而且SOAP仅支持XML，REST允许多种不同的数据格式，例如JSON，JSON更适用于承载数据而且解析起来更快，因此REST也更好地支持浏览器客户端，同时REST具备更好的性能和可扩展性等优点。

因此很多系统对外开放的接口都采用了REST协议，这说明曾经流行的SOAP现在逐渐被REST替代，但是依然有很多第三方系统以SOAP协议去调用接口，这使得开发人员在开发基于RESTful风格的新项目时，仍然需要调用SOAP Web服务，因此需要在开发程序中额外构建SOAP客户端或者同时写一套REST接口和SOAP接口，由此增加了项目的开发难度和成本，而且当一个系统对外开发的接口数量较多时，开发难度和成本随之显著增加。

基于此，本申请实施例提供了一种API接口访问方法、转换方法、装置、设备及存储介质，能够使得第三方系统可以通过SOAP协议来调用REST业务接口。

本申请实施例提供的API接口访问方法、转换方法、装置、设备及存储介质，具体通过如下实施例进行说明。

需要说明的是，在本申请的各个具体实施方式中，当涉及到需要根据用户信息、用户行为数据，用户历史数据以及用户位置信息等与用户身份或特性相关的数据进行相关处理时，都会先获得用户的许可或者同意，例如，获取用户存储的数据以及用户的缓存数据访问请求时，均会先获得用户的许可或者同意；或者，获取系统的内容数据时，需要先获得用户的许可或者同意，在导入数据到新的系统上时，也需要先获得用户的许可或者同意。而且，对这些数据的收集、使用和处理等，都会遵守相关国家和地区的相关法律法规和标准。此外，当本申请实施例需要获取用户的敏感个人信息时，会通过弹窗或者跳转到确认页面等方式获得用户的单独许可或者单独同意，在明确获得用户的单独许可或者单独同意之后，再获取用于使本申请实施例能够正常运行的必要的用户相关数据。

本申请实施例中的API接口访问方法可以通过如下实施例进行说明。

参照图1所示，图1是本申请一个实施例提供的用于执行API接口访问方法的系统架构示意图。在图1的示例中，该系统架构包括Web Service请求方110、平台服务器120和接口提供方130。

其中，平台服务器120与Web Service请求方110通信连接，用于接收Web Service请求方110发起的Web Service接口请求，例如SOAP请求，在平台服务器120内实现对接口请求的转换，并向接口提供方130发送转换后符合相应规格的接口请求，例如REST请求。

接口提供方130与平台服务器120通信连接，用于接收平台服务器120的请求，对接收到的请求进行处理并返回请求结果给平台服务器120。平台服务器120对接口提供方130返回的请求结果进行解析并组装成Web Service请求方110对应的响应报文，使WebService请求方110通过平台服务器120得以顺利访问接口提供方130的接口。

在本申请一些实施例中，Web Service请求方110与平台服务器120建立远程通信连接，例如互联网连接，平台服务器120与接口提供方130建立通信连接，例如远程互联网连接或本地服务连接。

在本申请一些实施例中，Web Service请求方110可以是手机客户端等第三方系统，也可以是本地平台服务器的SOAP UI模拟调用工具。

本申请实施例描述的系统架构以及应用场景是为了更加清楚的说明本申请实施例的技术方案，并不构成对于本申请实施例提供的技术方案的限定，本领域技术人员可知，随着系统架构的演变和新应用场景的出现，本申请实施例提供的技术方案对于类似的技术问题，同样适用。

本领域技术人员可以理解的是，图1中示出的系统架构并不构成对本申请实施例的限定，可以包括比图示更多或更少的部件，或者组合某些部件，或者不同的部件布置。

参照图2所示，图2是本申请实施例提供的API接口访问方法的一个可选的流程图，该API接口访问方法应用于平台服务器，例如应用于如图1所示实施例中的平台服务器120，该API接口访问方法包括但不限于包括步骤S101至步骤S105。

步骤S101，获取Web Service接口请求；

在本申请一些实施例中，平台服务器120通过与Web Service请求方110的通信连接从而获取Web Service请求方110发出的Web Service接口请求，其中，Web Service接口请求为SOAP协议请求。需要指出的是，Web Service请求方110可以是手机客户端等第三方系统本身，也可以是和第三方系统具有通信连接的其他系统，或者是平台服务器120本地的接口调用工具（如SOAP UI工具），其可以通过模拟调用发出Web Service接口请求，本申请实施例对此不做具体限制。

步骤S102，获取待访问的API接口的接口信息；

在本申请一些实施例中，平台服务器120根据Web Service接口请求获取待访问的API接口的接口信息，具体的，API接口为REST协议接口，由接口提供方130提供。可以理解的是，接口提供方130可以是远程的也可以是本地服务，对不同的接口提供方130，平台服务器120调用对应的Report解析待访问的API接口以获取接口信息。示例性的，Web Service请求方110发起SOAP请求（Web Service接口请求）请求访问接口提供方130提供的REST接口，那么待访问的API接口即为REST接口。

步骤S103，得到API接口对应的接口结构描述信息；

在本申请一些实施例中，平台服务器120根据接口信息进一步得到API接口对应的接口结构描述信息，具体的，当API接口为REST接口时，接口结构描述信息可以为JsonSchema描述。

步骤S104，将Web Service接口请求转换成REST请求；

在本申请一些实施例中，平台服务器120根据接口结构描述信息将Web Service接口请求转换成REST请求。示例性的，平台服务器120根据接口的Json Schema描述将WebService接口请求转换成REST请求。

步骤S105，发送所述REST请求到所述API接口；

示例性的，平台服务器120将Web Service请求方110的SOAP请求转换成REST请求后，平台服务器120对接口提供方130发起REST请求，可以理解的是，接口提供方为Open API接口提供方，因此平台服务器120发送REST请求到API接口以完成Web Service请求方110发起的请求。

参照图3所示，在本申请一些实施例中，步骤S102到S103过程中还可以包括但不限于包括步骤S201步骤S203。

步骤S201，根据Web Service接口请求的XML请求报文，获取请求路径；

可以理解的是，Web Service请求方110发起的Web Service接口请求为SOAP请求时，其包含XML请求报文，因此在本申请一些实施例中，平台服务器120通过对XML请求报文进行解析从而获取请求路径。示例性的，从HttpServletRequest（用来处理一个对Servlet的HTTP格式的请求信息）获取请求路径。

步骤S202，获取所述API接口的API接口类名（即API接口ClassName）和API实现类类名（即API实现类ClassName）；

在本申请的一些实施例中，平台服务器120根据请求路径进一步获取API接口的API接口类名和API实现类类名，可以理解的是，还可以获取应用地址信息。

可以理解的是，待访问的API接口为开放接口。例如，待访问的API接口可以是具有与平台服务器约定的Open API注解的Open API接口，Open API注解内容可以根据需要自定义，平台服务器120可以通过监听各个API接口是否具有约定的Open API注解，以获取和存储API接口的接口信息。

示例性的，约定的Open API注解部分内容可以如下，主要包含接口运行时间、开放接口声明、对外开放的接口协议、接口名称等信息：

@Open API注解定义：

@Retention(RetentionPolicy.RUNTIME) 接口运行时间

@GlobalExtensionPoint(label = "开放接口声明", config =

Open APIConfig.class, listener =

"com.XXXX.tic.gateway.core.service.TicGatewayAPIService")

public @interface Open API {

/** InterfaceAbilityExtension对应的模块ID */

String moduleId() default "";

/** 接口协议，指需要对外开放的接口API */

Class< > APIInterface();

/** 接口名称 */

String label();}。

示例性的，当API接口为REST接口时，通过请求路径获取实现Open API注解的REST接口实例信息，包括REST接口所在的应用信息，API接口类名、API实现类类名，以及应用地址信息。

步骤S203，用Java反射机制，解析出API接口的对应的接口结构描述信息；

在本申请的一些实施例中，根据API接口类名和API实现类类名，通过Java的反射机制，解析出API接口对应的接口结构描述信息。示例性的，通过OpenAPI注解获得API接口应用信息，判断接口提供方130是远程还是本地服务，调用对应的Report接口进行解析，通过API接口类名及API实现类类名，用Java反射解析出调用接口的出入参Json Schema信息。

参照图4所示，在本申请一些实施例中，步骤S203还可以包括但不限于包括步骤S301至步骤S303。

步骤S301，用Java反射机制获取对应的入参方法信息和出参方法信息；

需要指出的是，接口结构描述信息包括入参结构信息和出参结构信息，其中，入参结构信息包括入参方法信息和入参类型信息，出参结构信息包括出参方法信息和出参类型信息。示例性的，一个项目中的Java类的父类名为ISysNotifyTodoAndDoneQueryAPI，当该Java类打上@Open API后，表示父类里面的所有接口都需要作为开放接口给到第三方系统调用。在本申请一些实施例中，根据API接口类名，用Java反射机制获取对应的入参方法信息和出参方法信息。具体的，根据@Open API注解声明的ISysXXXXOpen API，用Java反射机制获取API接口类名，从而获取得到方法信息。

步骤S302，用Java反射机制获取对应的入参类型信息和出参类型信息；

在本申请一些实施例中，根据API实现类类名和入参方法信息、出参方法信息，用Java反射机制获取对应的入参类型信息和出参类型信息。示例性的，遍历接口类名里面的方法method信息，通过实现类及method，通过method.getGenericParameterTypes()及method.getGenericReturnType()分别拿到方法的入参类型信息和出参类型信息。

下面用一个具体示例说明用Java反射机制，解析出API接口的对应的接口结构描述信息的过程：

1.该示例中，该API接口的Java类打上@Open API注解后，表示父类ISysNotifyTodoAndDoneQueryAPI里面的所有接口都需要作为开放接口给到第三方系统调用。

该示例中，Open API注解主要包括以下内容：

@Open API(moduleId="simple-app",label="消息中心开放接口",APIInterface=ISysXXXXOpen API.class)

@RequestMapping("/api/simple-app/demoWebService ")

public class SysXXXXOpen API implements ISysXXXXOpen API {

public Response<String> done(@RequestBody NotifyContext context){

return dispatch(context, CMD_DONE);

}

其中，RequestMapping为该API接口实例的路径值。通过API接口实例的路径值，可通过Java反射的方式解析得到REST API接口的接口类名（API接口ClassName），并进一步获取接口schema描述的代码，具体示例如下：

首先，开放接口ISysXXXXOpen API的注解声明示例如下：

@Setter

@Getter

public class TicOpen APIDTO{

/*接口协议*/

private String APIInterface;

/** 接口名称 */

private String label;

/** REST路径 */

private String RESTUrl;

/** 类型清单 */

private Map<String, JsonSchema> types;

/** REST方法清单 */

private List<TicOpen APIMethodDTO> methods;

}

开放接口方法描述信息如下：

@Setter

@Getter

public class TicOpen APIMethodDTO {

/** 方法名称 */

private String label;

/** 方法Id */

private String id;

/** 入参描述 */

private JsonSchema argument;

/** 出参描述 */

private JsonSchema returnType;

}

根据以上@Open API注解声明的ISysXXXXOpen API，用Java反射获取它本身的API接口类名，即API接口ClassName（ifaceClazz），以及API实现类的API实现类类名，API实现类ClassName（implClazz），获取到它所有的方法信息，遍历ifaceClazz里面的方法信息method，通过API实现类的implClazz及方法信息method，用method.getGenericParameterTypes()及method.getGenericReturnType()分别拿到方法的入参和出参Type，根据不同的Type转成对应的schema参数描述。具体过程如下：

①根据Open API注解解析RESTAPI，得到API实现类。

@return RESTAPI返回所有接口名称、每个接口schema描述信息、接口请求路径

②根据API接口类名和API实现类类名，获取REST API接口schema描述，包括：构造接口方法schema描述，包含构造基础属性、接口入参、接口出参，得到各类型参数；根据类型参数构造JsonSchema。

步骤S303，形成接口结构描述信息；

在本申请一些实施例中，根据入参类型信息和出参类型信息，形成接口结构描述信息，具体的，根据不同的类型信息形成对应的Json Schema参数描述。可以理解的是，根据API接口类名，通过Java反射机制可以获取出该API接口类中具有什么接口及方法，方法中进一步包含有出入参的对象信息，根据对象的属性通过对应的Json Schema参数描述即可形成该API接口的接口结构描述信息。

示例性的，以待访问接口为send接口为例，通过Java反射拿到send类型入参方法信息、出参方法信息的schema部分描述如下：

"label": "发送消息",

"id": "send", // 方法名称

"argument": {

"type": "object", // 入参类型-对象

"$schema": "NotifySendContext_in" // 入参方法信息

},

"returnType": {

"type": "object", // 出参类型-对象

"$schema": "Response_String_out" // 出参方法信息

}

},

方法出入参对象属性（入参类型信息和出参类型信息）schema部分描述如下：

"properties": { // send接口入参属性（入参类型信息）

"appName": {

"type": "string",

"id": "appName"

}……

"properties": { // done接口入参属性字段描述

"appName": {

"type": "string",

"id": "appName"

},…..

"properties": { // 出参属性字段描述（出参类型信息）

"code": {

"type": "string",

"id": "code",

"description": "成功/错误的messageKey"

},…….

参照图5所示，在本申请一些实施例中，步骤S104还可以包括但不限于包括步骤S401至步骤S404。

步骤S401，解析XML请求报文，得到第一对象节点信息；

在本申请一些实施例中，第一对象节点为Element元素节点，示例性的，平台服务器120对Web Service请求方110的SOAP请求中的XML请求报文进行解析从而获取得到Element元素节点信息。

步骤S402，根据接口结构描述信息，构建JSON对象；

在本申请一些实施例中，根据Json Schema参数描述信息构建JSON对象JSONObject。

步骤S403，将第一对象节点值对应存储到JSON对象，得到REST请求的主体信息；

在本申请一些实施例中，将第一对象节点信息对应的节点值存储到JSON对象JSONObject中，从而得到REST请求的主体信息。

步骤S404，组装成REST请求；

在本申请一些实施例中，根据REST接口的Json Schema参数描述，将JSONObject对象转成REST接口中的JSON请求参数对象，并提取出REST请求方法名称信息，从而组成REST请求。

参照图6所示，在本申请一些实施例中，步骤S401还可以包括但不限于包括步骤S501至步骤S502。

步骤S501，将XML请求报文转换成文档类数据，从文档类数据中获取主体信息；

在本申请一些实施例中，平台服务器120将SOAP请求的XML请求报文转换成文档类数据，可以是txt文档或doc文档，基于文档类数据获取SOAP请求的主体信息，可以理解的是，主体信息包括接口名name、命名空间dns、调用路径等location。

步骤S502，根据第一遍历规则遍历文档类数据主体信息中的第一对象节点，获取得到多个第一对象节点对应的第一对象节点值；

可以理解的是，第一遍历规则为逐层遍历或递归遍历，第一对象节点包括纯文本Element元素节点和对象类型Element元素节点。示例性的，先声明一个JSON Object对象（JSON对象），用于存储请求所有Element元素节点值信息，再层层遍历文档类数据中的Element元素节点，如果是纯文本Element节点，获取到节点值后，存储到JSON Object对象中，如果是对象类型Element节点，则递归遍历Element对象子节点，将节点值存储到JSONObject对象。

可以理解的是，可根据REST接口参数schema描述，将XML请求报文的主体内容转成REST接口中的Json请求参数对象。

示例性的，将XML请求报文的主体内容转换成REST请求主体Body，以得到REST API请求的json报文的部分操作命令如下：

public String getExecuteBody() {

// 从SOAP请求XML报文中解析出需要调用的接口名称

loadMethod();

if (method == null) {

return null;

}

// 定位XML请求报文的主体内容，转换成REST API请求的json报文

Element element = getBody().elements().get(0);

JSONObject json = new JSONObject();

// 解析XML请求报文，将节点值存储到jsonObject对象

XMLToJson(element, json);

Object value = json.get(SoapNaming.OPERATION_INPUT_ROOT);

// 根据入参格式转换

value = JsonSchemaUtil.convert(value, method.getArgument(), false,"",

API.getTypes());

// 返回

return JsonUtil.toJsonString(value);

}

示例性的，步骤S502中，可将Web Service请求的XML请求报文转换成文档类数据Document,从文档类数据Document获取到头部Header和主体body信息。先构建声明一个JSON Object对象，用来存储请求所有Element节点值信息，再层层遍历或递归遍历Document中的Element节点，分别处理纯文本Element节点与对象类型Element节点，获取到节点值后，存储到JsonObject。

参照图7所示，在本申请一些实施例中，步骤S101之前还可以包括但不限于包括步骤S601至步骤S602。

步骤S601，监听已实现平台预设注解规则注解的API接口实例；

在本申请一些实施例中，需要对外暴露，例如对Web端、手机客户端等除了平台服务器120之外的第三方系统暴露的REST接口均通过实现Open API自定义注解进行注册，以便统一维护，处理接口认证、鉴权、限流、熔断以及统一日志与监控等工作。可以理解的是，Open API接口支持REST与SOAP协议调用。

参照图8所示的Open API接口设计流程图，首先通过自定义Open API注解，然后再定义Open API注解监听器，通过监听扫描Open API注解信息判断是否存在Open API接口实例。在一些示例中，Open API注解监听器可以通过平台服务器中的容器实现。

步骤S602，获取并存储监听到的所述API接口实例的请求路径、API接口类名和API实现类类名；

在本申请一些实施例中，参照图8所示的Open API接口设计示意图，当监听到已实现平台预设注解规则注解的Open API接口实例时，获取其RequestMapping信息，然后将RequestMapping路径作为id、接口协议ClassName信息注入到缓存，即缓存Open API接口实例的请求路径及实例实现类。

本申请一些实施例中的实现平台预设注解规则注解的API接口实例，参照图9所示的Open API接口注册流程图，首先通过平台服务器120定义REST接口API，API实例实现OpenAPI自定义注解，指定接口所属的应用名称、需要对外暴露的接口协议，其中对外是指对Web、手机客户端等的第三方系统，然后设置API授权信息，基于授权信息判断是否需要进行认证，如果授权信息不需要认证则代表API授权为匿名访问直接授权成功，否则需要创建认证账号，可以理解的是，身份认证通常是指账号认证，如果是REST方式访问接口，支持接口basic认证或OAuth2认证，如果是SOAP方式访问，则支持WS-Security(userToken)认证，此时API授权为账号访问从而授权成功；授权成功后判断是否需要限流，不需要限流则结束，否则进行全局限流或者接口限流。

进一步的，在上述过程中，利用平台服务器120的API网关管理对各个过程进行管理，具体的，API网关管理包括：API服务、账号管理和授权管理。参照图10所示的平台服务器API服务界面示意图，示例性的，平台服务器可以通过注解监听器（可通过容器实现）扫描已实现Open API注解的REST接口，并在API服务界面中，所有配置@Open API注解的服务都会被读取显示到平台服务器平台的API服务列表中。具体的，包括序号、API名称、API分类、API路径及其他相关操作信息等。

参照图11所示的平台服务器账号管理界面示意图，示例性的，账号管理用于配置第三方实际调用时使用的授权账号，由于平台服务器网关对外开放的API通常都要进行身份认证，账号管理则配置提供给第三方的认证账号信息。可以理解的是，在新建账号时，可以选择账号的认证方式，平台服务器平台提供SOAP和REST两种协议类型，SOAP对应有WS-Security认证，而REST则对应有basic认证或OAuth2认证。

参照图12所示的平台服务器授权管理界面示意图，示例性的，授权管理中可以配置各个业务模块Open API的访问策略，支持账号访问和匿名访问，具体的，可以平台服务器平台的在“账号名称”处配置哪些账号可以访问API服务，在“可访问API服务”处配置哪些API服务可以被第三方服务，以及在“可使用的客户端IP”处限制哪些IP可以访问API服务等，具体可以按照实际需求进行设置，本申请实施例不做限制。

参照图13所示，在本申请一些实施例中，步骤S101之前还可以包括但不限于包括步骤S701至步骤S702。

步骤S701，通过预设的WSDL描述获取接口，获取得到API接口的WSDL描述信息；

在本申请一些实施例中，平台服务器提供专门的接口，例如WSDL接口，以获取REST接口的WSDL描述信息，不仅可以检测服务可用性，还可以查看接口出入参的详细信息，可以理解的是，通过WSDL接口可基于SOAP UI模拟调用REST接口。因此，本申请一些实例中通过预设的WSDL描述获取REST接口，从而获取得到REST接口的WSDL描述信息。

示例性的，可通过定义一个URLMapping为“/Web Service/**”的动态Get请求接口，支持已实现Open API注解的REST接口获取WSDL描述。

接口定义信息会在内部上缓存预设时间（如1天），若接口变动后需要立即刷新，执行refresh指令，如：/WebService/simple-app/demoWeb Service-refresh。若想获取最新接口描述信息，执行WSDL指令,如：/WebService/simple-app/demoWebService-wsdl。

步骤S702，组装得到Web Service接口请求；

在本申请一些实施例中，根据得到的WSDL描述信息，组装得到Web Service接口请求，即SOAP请求。

参照图14所示，在本申请一些实施例中，步骤S701还可以包括但不限于包括步骤S801至步骤S805。

步骤S801，监听已实现平台预设注解规则注解的API接口实例；

在本申请一些实施例中，首先通过自定义Open API注解，然后再定义Open API注解监听器，通过扫描Open API注解信息监听是否存在Open API接口实例。

步骤S802，获取并存储监听到的API接口实例的请求路径；

在本申请一些实施例中，当监听到已实现平台预设注解规则注解的Open API接口实例时，获取并存储监听到的API接口实例的请求路径，具体的，Open API注解监听器把监听到所有已实现Open API注解的接口实例的请求路径值作为Open API唯一标识id，并将其缓存起来。

步骤S803，得到API接口的接口信息；

在本申请一些实施例中，Open API注解监听器还将请求路径与API接口实现类类名缓存起来，在API接口调用时，通过识别URL请求路径，获取到调用API接口的接口信息。

步骤S804，得到API接口对应的接口结构描述信息；

在本申请一些实施例中，基于Open API接口实现类类名，通过Java反射机制获取得到Open API接口下的所有出入参描述信息，即得到API接口对应的接口结构描述信息。

步骤S805，根据接口结构描述信息和预设的目标格式模板，构建API接口的WSDL描述信息；

在本申请一些实施例中，根据出入参描述信息和目标格式模板，例如WSDL描述模板构建API接口的WSDL描述信息。

在本申请一些实施例中，API接口的接口信息包括API接口类名，所以根据API接口实例的请求路径得到API接口的接口信息，包括得到API接口类名。示例性的，Open API注解监听器将请求路径与API接口实现类类名缓存起来，在API接口调用时，通过识别URL请求路径，获取到调用API接口的接口信息及API接口类名。

进一步的，根据API接口类名和API实现类类名，用Java反射机制，解析出API接口对应的接口结构描述信息。示例性的，得到Open API接口下的所有出入参描述信息。

参照图15所示，在本申请一些实施例中，步骤S805还可以包括但不限于包括步骤S901至步骤S904。

步骤S901，遍历API接口的对应的接口结构描述信息，为WSDL基础元素节点赋值；

可以理解的是，WSDL基础元素节点包括以下的至少一种：接口名、命名空间、调用路径。在本申请一些实施例中，根据WSDL标准规范设置WSDL基础元素节点，如接口名name、命名空间dns、调用路径location等，通过遍历Open API接口Json Schema出入参描述给上述基础元素节点进行赋值。

步骤S902，根据接口结构描述信息对应的参数类型，构造WSDL类型节点；

在本申请一些实施例中，根据Java反射机制生成REST接口Json Schema参数描述时获取到的不同参数类型集合，遍历构造出ComplexType对象类型节点和SimpleType枚举类型节点的WSDL类型节点。

步骤S903，根据接口结构描述信息对应的方法信息，构造生成对应的Element元素节点；

在本申请一些实施例中，调取REST接口所有的方法描述Json Schema，根据不同类型的Json Schema构造生成对应的Element元素节点。

步骤S904，利用目标格式模板，将WSDL基础元素节点、WSDL类型节点、Element元素节点组装形成目标格式的WSDL描述信息；

在本申请一些实施例中，动态生成WSDL文档描述，需要预定义WSDL模板的XML文档，以便精确描述SOAP接口信息，因此文档规范必须遵循WSDL XML模式。具体的，文档内容定义Types、Message、Operation、PortType、Bingding、Port、Service等元素节点，接口描述信息指定为参数占位符。WSDL上下文构造完成组装的根节点对象传递给目标格式模板，组装形成目标格式的WSDL描述信息。

在本申请一些实施例中，关于采集REST接口数据并构造WSDL上下文的具体流程参照图16所示，首先接收到WSDL接口描述请求，然后通过获取Open API接口实例信息，从而组装Open API接口的Json Schema信息，构造WSDL上下文，组装接口名name、命名空间dns、调用路径location等基础属性，然后构造XML Schema数据类型定义类型节点，具体的，解析对象参数类型构造ComplexType节点，或者解析枚举参数类型构造SimpleType节点，然后解析API出入参属性，遍历方法信息，接着解析API接口Schema描述构造操作节点，最后判断是否转换成功，如果转换成功则返回WSDLView成功视图，否则判断失败原因并组装失败信息后返回WSDLView失败视图。可以理解的是，当Open API实例不存在、调用的接口API不存在或者WSDL上下文构造失败时，也对失败的原因进行判断并组装失败信息后返回WSDL失败视图。

示例性的，可通过定义一个URLMapping为“/Web Service/**”的动态Get请求接口，支持已实现Open API注解的REST接口获取WSDL描述。若想获取最新接口描述信息，执行WSDL指令,如：/Web Service/simple-app/demoWeb Service-wsdl。

示例性的，第三方（如Web Service接口请求方）可以通过以下示例请求获取REST接口的WSDL描述：

请求路径:http://127.0.0.1:XXXX/web Service/simple-app/demoWebService-wsdlXXXX

请求方式:GET

请求类型：application/XML。

参照图17所示，在本申请一些实施例中，步骤S105之后还可以包括但不限于包括步骤S1001至步骤S1005。

步骤S1001，获取来自API接口的JSON响应报文；

在本申请一些实施例中，当平台服务器120发送REST请求到接口提供方130后，接口提供方130对接收到的REST请求进行解析处理后应答形成对应的JSON响应报文，从而通过API接口返回被平台服务器120获取。

步骤S1002，解析得到响应主体信息；

在本申请一些实施例中，平台服务器120对接收到的JSON响应报文进行解析从而得到响应主体信息，可以理解的是，响应主体信息包括接口名等。

步骤S1003，获取预设的XML响应报文模板；

在本申请一些实施例中，Web Service请求方110发起的请求是基于XML的SOAP请求，因此平台服务器120需要获取预设的XML响应报文模块，以将接口提供方130返回的JSON响应报文进行转换。

在本申请一些实施例中，SOAP协议转换需自定义SOAP请求响应XML模板依赖文件，即XML响应报文模板。XML响应报文模板可以包括调用失败XML模板、调用成功XML模板，XML响应报文模板可以包含XML响应报文的格式，主体信息参数指定为参数占位符。

步骤S1004，组装得到XML响应报文；

在本申请一些实施例中，根据响应主体信息和XML响应报文模板，组装得到XML响应报文。

示例性的，可以将XML响应报文模板中的参数占位符替换为响应主体信息，以组装形成XML响应报文。例如，通过方法名组装出Soap响应报文（XML响应报文）中的“ns2:”、与命名空间DNS等信息，用REST出参Json Schma描述信息，递归解析出数组、对象与简单类型的REST出参信息（响应主体信息），根据WSDL标准规范（XML响应报文模板）组装成对应XML响应报文。

例如，对于调用成功的情况，可以获取调用成功XML模板，将调用成功XML模板中的参数占位符替换为调用成功JSON响应报文的响应主体信息，以组装形成调用成功的XML响应报文；对于调用失败的情况，可以获取调用失败XML模板，将调用失败XML模板中的参数占位符替换为调用失败JSON响应报文的响应主体信息，以组装形成调用失败的XML响应报文。

步骤S1005，发送给Web Service请求方。

在本申请一些实施例中，将组装好的XML响应报文发送给Web Service请求方110，示例性的，Web Service请求方110可以是SOAP UI模拟工具或其他第三方系统，本申请实施例对此不做限制。

示例性的，解析REST接口返回Json响应报文，转成XML响应报文的部分过程如下：

①获取REST接口返回Json响应报文；

②递归解析Json响应报文的body信息；

③将解析得到的Json响应报文的body信息传递给soap-response.XML（XML响应报文模板。

至此，平台服务器完成了从Web Service接口请求到请求响应的过程，实现了通过SOAP协议访问REST接口。

在本申请一些实施例中，在API接口访问过程中还包括获取API接口的访问策略，包括鉴权访问策略、限流访问策略、熔断策略中的至少一种。

示例性的，当访问策略包括鉴权访问策略时，根据Web Service接口请求获取待访问的API接口的接口信息过程中还包括：根据Web Service接口请求，获取待访问的API接口的接口信息和访问账号，根据访问账号信息和预设的账号权限对应关系，判断所述访问账号的访问权限。

示例性的，当访问策略包括限流访问策略，根据Web Service接口请求，获取待访问的API接口的接口信息之后还包括：获取待访问的API接口的限流访问策略，根据限流访问策略，对API接口进行对应流量控制。

示例性的，当访问策略包括熔断访问策略，根据Web Service接口请求，获取待访问的API接口的接口信息之后还包括：获取待访问的API接口的熔断访问策略，根据熔断访问策略，对API及接口进行对应熔断保护控制。

下面以三个示例进一步说明本申请API接口访问方法。

示例一

参照图18所示的API接口访问流程图，在本申请一些实施例中，包括以下步骤：

1.Web Service请求方110发起的Web Service接口请求为SOAP请求，可以理解的是，Web Service请求方可以是第三方系统，也可以是SOAP UI模拟工具。

示例性的，当SOAP UI模拟工具发起SOAP请求前，可以通过Get请求连接WSDL接口从而获取WSDL描述文档模块，然后根据文档模板对参数进行填充形成入参报文，即可模拟调用Web Service接口。

2.平台服务器120根据SOAP请求获取SOAP接口详情，然后解析SOAP请求中的XML请求报文，获取待访问的REST接口的接口信息。

3.平台服务器120接着对待访问的接口信息进行接口鉴权，如果鉴权不通过，则结束Web Service请求方的接口访问请求。

示例性的，通过SOAP请求URL信息，判断该接口是否需要WS-usertoken认证鉴权，需要鉴权则解析出的报文头部信息获取到用户名密码，处理鉴权逻辑。

4.如果鉴权通过，则获取Json Schema接口描述，将XML请求报文转换成REST请求主体，平台服务器120对接口提供方130发起REST请求。

5.接口提供方130对接收到的REST请求进行解析处理后返回请求结果到平台服务器120。具体的，执行REST请求过程中通过调用对应的REST接口，获取接口响应JSON报文。

6.解析REST接口响应的JSON响应报文，组装成XML响应报文。由于不同的接口返回的数据结构不同，本申请统一以String类型接收返回参数。可以理解的是，请求结果为基于的JSON的响应报文，平台服务器120对JSON响应报文进行解析后组装形成对应的XML响应报文，即SOAP调用响应解析。具体的，可通过方法名组装出SOAP响应报文中的“ns2:”、与命名空间“dns”等信息，使用REST出参Json Schema描述信息，递归解析出数组、对象与简单类型的REST出参信息，根据WSDL描述文档模板规范，组装成对应XML响应报文。

7.将发送XML响应报文至Web Service请求方，完成对REST接口的访问请求。

通过Web Service请求调用REST接口的请求报文和响应报文示例如下，该示例中，REST接口对应为send服务（发送信息服务）。

其中，Web Service请求路径：

http://127.0.0.1:XXXX/web Service/simple-app/demoWebServiceXXXX

请求方式：POST

请求类型：application/XML

Web Service接口请求报文：

<soapenv:Envelope XMLns:soapenv="http://schemas.XMLsoap.org/soap/envelope/" XMLns:API="http://API.XXXX.sys.XXXX.com/">

<soapenv:Header/> // soap头部信息

<soapenv:Body> // body请求体

<API:send_in> // 接口名称

<arg0> // 接口入参节点

<entityName>com.XXXX.kms.exam.Activity</entityName>

<notifyType>todo,dingTalkTodo</notifyType>

<orgProperty>fdLoginName</orgProperty>

<targets>[

"11118888"

</targets>

</arg0>

</API:send_in>

</soapenv:Body>

</soapenv:Envelope>

XML响应报文（调用成功）：

<soap:Envelope XMLns:soap="http://schemas.XMLsoap.org/soap/envelope/">

<soap:Body> // body响应体

<ns2:send_out XMLns:ns2="http://API.XXXX.sys.XXXX.com/">

<return> // 接口出参节点

<msg>您的操作已成功！</msg>

<traceId>1g8lo51mtw8swjhpsw10cjns4knv4am3mkw0</traceId>

<code>return.optSuccess</code>

<data>1g8lo51nlw8vwckon8w3k11l1lhgh5gg2nw0</data>

</return>

</ns2:send_out>

</soap:Body>

</soap:Envelope>

综上所述，本申请实施例可将SOAP协议转为REST协议，可用于第三方系统（WebService请求方）通过平台服务器调用本系统已指定的Open API的场景。在接口调用前，可以通过JAVA反射的方式解析接口属性，生成XML形式的WSDL描述，使得第三方系统可以通过SOAP协议来调用业务接口，而各个业务模块不需要单独为接口去发布Web Service服务。系统开发的时候只需要提供REST协议的接口，通过在网关层（或拦截器，即平台服务器）中对请求报文进行转换。另外，对外提供接口的WSDL的地址，则可以自动把REST接口对外开放为SOAP接口。

第三方系统常用的接口协议有：REST协议、SOAP协议等方式，每个接口也会有细微的差异，而本申请实施例对外接口统一以REST协议调用，利用平台服务器的协议转换功能，能将第三方系统的接口差异抹平，实现零编码快速集成不同接口协议。

另外，当业务模块REST API接口需要暴露给第三方系统调用时，通过在API接口实现类声明Open API注解可以将业务模块的接口调用托管给集成平台。协议转换使本系统接口既支持REST方式调用，也支持Soap方式调用。而通过OpenAPI注解声明，还能利用平台服务器实现本系统预定义的集成能力，如接口认证、限流、熔断、统一日志与监控，使整个集成过程更加无缝连接。

在本申请一些实施例中，提供一种接口描述转换方法，具体步骤可以包括但不限于包括以下步骤S1101至S1105。

步骤S1101，监听已实现平台预设注解规则注解的API接口实例；

在本申请一些实施例中，首先通过自定义Open API注解，然后再定义Open API注解监听器，通过扫描Open API注解信息监听是否存在Open API接口实例，可以理解的是，API接口为REST协议接口。

步骤S1102，获取并存储监听到的API接口实例的请求路径；

步骤S1103，得到API接口的接口信息；

步骤S1104，得到API接口对应的接口结构描述信息；

步骤S1105，根据接口结构描述信息和预设的目标格式模板，构建API接口的WSDL描述信息；

在本申请一些实施例中，根据描述信息和目标格式模板，例如WSDL描述模板进而构建API接口的WSDL描述信息。

在本申请一些实施例中，平台服务器平台提供专门的接口，例如WSDL接口，以获取REST接口的WSDL描述信息，不仅可以检测服务可用性，还可以查看接口出入参的详细信息，可以理解的是，通过WSDL接口可基于SOAP UI模拟调用REST接口。因此，本申请一些实例中通过预设的WSDL描述获取REST接口，从而获取得到REST接口的WSDL描述信息。

示例性的，WSDL接口定义，通过定义一个URLMapping为“/Web Service/**”的动态Get请求接口，支持已实现Open API注解的REST接口获取WSDL描述。

接口定义信息会在内部上缓存预设时间（如1天），若接口变动后需要立即刷新，执行refresh指令，如：/Web Service/simple-app/demoWeb Service-refresh。若想获取最新接口描述信息，执行WSDL指令,如：/Web Service/simple-app/demoWeb Service-wsdl。

在本申请一些实施例中，步骤S1105还可以包括但不限于包括步骤S1201至步骤S1204。

步骤S1201，遍历API接口的对应的接口结构描述信息，为WSDL基础元素节点赋值；

可以理解的是，WSDL基础元素节点包括以下的至少一种：接口名、命名空间、调用路径。在本申请一些实施例中，根据WSDL标准规范设置WSDL基础元素节点，如接口名name、命名空间dns、调用路径location，遍历Open API接口Json Schema出入参描述给上述基础元素节点进行赋值。

步骤S1202，根据接口结构描述信息对应的参数类型，构造WSDL类型节点；

步骤S1203，根据接口结构描述信息对应的方法信息，构造生成对应的Element元素节点；

步骤S1204，利用目标格式模板，将WSDL基础元素节点、WSDL类型节点、Element元素节点组装形成目标格式的WSDL描述信息；

在本申请一些实施例中，动态生成WSDL文档描述，需要预定义WSL模板的XML文档，以便精确描述REST接口信息，因此文档规范必须遵循WSDL XML模式。具体的，文档内容定义Types、Message、Operation、PortType、Bingding、Port、Service等元素节点，接口描述信息指定为参数占位符。WSDL上下文构造完成组装的根节点对象传递给目标格式模板，组装形成目标格式的WSDL描述信息。

请求路径:http://127.0.0.1:XXXX/Web Service/XXXXX

请求方式:GET

请求类型：application/XML。

本申请实施例第二方面提供的接口描述转换方法，包括：监听已实现平台预设注解规则注解的API接口实例，获取并存储监听到的所述API接口实例的请求路径，根据所述API接口实例的请求路径，得到所述API接口的接口信息，根据所述接口信息，得到所述API接口对应的接口结构描述信息，根据所述接口结构描述信息和预设的目标格式模板，构建所述API接口的WSDL描述信息。本申请实施例与相关技术相比，通过将API接口的接口描述转换为WSDL描述信息，以方便第三方查看，从而方便用户通过SOAP协议来访问REST业务接口。即是说，本申请实施例系统开发的时候只需要提供REST协议的接口，对外提供接口的wsdl的地址，实现自动把REST接口对外开放为SOAP接口。

综上所述，本发明一方面公开了一种REST接口转换为Web Service接口的方法，能将内部的REST协议转换成SOAP协议，屏蔽了接口差异，避免同一接口多次编写的麻烦；另一方面公开了一种REST接口的描述转换方法，可以将REST接口的接口描述转换为WSDL描述信息。主要解决的问题有两个：一是动态生成接口的WSDL信息，二是使用SOAP方式调用接口过程中，对接口参数进行数据结构转换。

参照图19所示，图19是本申请实施例提供的一种API接口访问装置功能模块示意图，可以实现上述API接口方法或API接口描述转换方法，该API接口访问装置设置于平台服务器120中，具体包括：

第一模块121，用于获取Web Service接口请求；其中，Web Service接口请求为SOAP协议请求。在本申请一些实施例中，将发起Web Service接口请求的对象称为WebService请求方110，可以理解的是，Web Service请求方110可以是手机客户端、Web端等第三方系统，也可以是平台服务器120本地的SOAP UI模拟工具，本申请实施例对此不做限制。

第二模块122，用于根据Web Service接口请求，获取待访问的API接口的接口信息。在本申请一些实施例中，Web Service请求方110发起的SOAP请求希望访问由接口提供方130提供的REST接口，可以理解的是，接口提供方130可以是远程的也可以是本地服务，对不同的接口提供方130，API接口访问装置中的第二模块122通过调用对应的Report解析待访问的API接口，即REST接口，以获取REST接口信息。

第三模块123，用于根据接口信息得到API接口对应的接口结构描述信息。在本申请一些实施例中，第三模块123根据第二模块122得到的接口信息，进一步得到API接口对应的接口描述信息，示例性的，当API接口为REST接口时，接口结构描述信息为Json Schema描述。

第四模块124，用于根据接口结构描述信息，将Web Service接口请求转换成REST请求。在本申请的一些实施例中，第四模块124根据接口结构描述信息，即Json Schema描述信息，转换成REST请求。

第五模块125，用于发送所述REST请求到所述API接口。在本申请一些实施例中，在第四模块124将Web Service请求方110的SOAP请求转换成REST请求后，平台服务器120对接口提供方130发起REST请求，可以理解的是，接口提供方为Open API接口提供方，因此第五模块125发送REST请求到API接口以完成Web Service请求方110发起的请求。

请参阅图20，图20示意了本申请一实施例的电子设备的硬件结构，电子设备140包括：

处理器141，可以采用通用的CPU(Central Processing Unit，中央处理器)、微处理器、应用专用集成电路(Application Specific Integrated Circuit，ASIC)、或者一个或多个集成电路等方式实现，用于执行相关程序，以实现本申请实施例所提供的技术方案；

存储器142，可以采用只读存储器（Read Only Memory，ROM）、静态存储设备、动态存储设备或者随机存取存储器(Random Access Memory，RAM)等形式实现。存储器142可以存储操作系统和其他应用程序，在通过软件或者固件来实现本说明书实施例所提供的技术方案时，相关的程序代码保存在存储器142中，并由处理器141来调用执行本申请实施例中的API接口访问方法及接口描述转换方法；

输入/输出接口143，用于实现信息输入及输出；

通信接口144，用于实现本设备与其他设备的通信交互，可以通过有线方式（例如USB、网线等）实现通信，也可以通过无线方式（例如移动网络、WIFI、蓝牙等）实现通信；

总线145，在设备的各个组件（例如处理器141、存储器142、输入/输出接口143和通信接口144）之间传输信息；

其中处理器141、存储器142、输入/输出接口143和通信接口144通过总线145实现彼此之间在设备内部的通信连接。

本申请实施例还提供了一种计算机可读存储介质，该计算机可读存储介质存储有计算机程序，该计算机程序被处理器执行时实现上述API接口访问方法或API接口描述转换方法。

存储器作为一种非暂态计算机可读存储介质，可用于存储非暂态软件程序以及非暂态性计算机可执行程序。此外，存储器可以包括高速随机存取存储器，还可以包括非暂态存储器，例如至少一个磁盘存储器件、闪存器件、或其他非暂态固态存储器件。在一些实施方式中，存储器可选包括相对于处理器远程设置的存储器，这些远程存储器可以通过网络连接至该处理器。上述网络的实例包括但不限于互联网、企业内部网、局域网、移动通信网及其组合。

本申请实施例描述的实施例是为了更加清楚的说明本申请实施例的技术方案，并不构成对于本申请实施例提供的技术方案的限定，本领域技术人员可知，随着技术的演变和新应用场景的出现，本申请实施例提供的技术方案对于类似的技术问题，同样适用。

本领域技术人员可以理解的是，图中示出的技术方案并不构成对本申请实施例的限定，可以包括比图示更多或更少的步骤，或者组合某些步骤，或者不同的步骤。

以上所描述的装置实施例仅仅是示意性的，其中作为分离部件说明的单元可以是或者也可以不是物理上分开的，即可以位于一个地方，或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部模块来实现本实施例方案的目的。

本领域普通技术人员可以理解，上文中所公开方法中的全部或某些步骤、系统、设备中的功能模块/单元可以被实施为软件、固件、硬件及其适当的组合。

本申请的说明书及上述附图中的术语“第一”、“第二”、“第三”、“第四”等(如果存在)是用于区别类似的对象，而不必用于描述特定的顺序或先后次序。应该理解这样使用的数据在适当情况下可以互换，以便这里描述的本申请的实施例能够以除了在这里图示或描述的那些以外的顺序实施。此外，术语“包括”和“具有”以及他们的任何变形，意图在于覆盖不排他的包含，例如，包含了一系列步骤或单元的过程、方法、系统、产品或设备不必限于清楚地列出的那些步骤或单元，而是可包括没有清楚地列出的或对于这些过程、方法、产品或设备固有的其它步骤或单元。

应当理解，在本申请中，“至少一个(项)”是指一个或者多个，“多个”是指两个或两个以上。“和/或”，用于描述关联对象的关联关系，表示可以存在三种关系，例如，“A和/或B”可以表示：只存在A，只存在B以及同时存在A和B三种情况，其中A，B可以是单数或者复数。字符“/”一般表示前后关联对象是一种“或”的关系。“以下至少一项(个)”或其类似表达，是指这些项中的任意组合，包括单项(个)或复数项(个)的任意组合。例如，a，b或c中的至少一项(个)，可以表示：a，b，c，“a和b”，“a和c”，“b和c”，或“a和b和c”，其中a，b，c可以是单个，也可以是多个。

在本申请所提供的几个实施例中，应该理解到，所揭露的系统和方法，可以通过其它的方式实现。例如，以上所描述的系统实施例仅仅是示意性的，例如，上述单元的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式，例如多个单元或组件可以结合或者可以集成到另一个系统，或一些特征可以忽略，或不执行。另一点，所显示或讨论的相互之间的耦合或直接耦合或通信连接可以是通过一些接口，装置或单元的间接耦合或通信连接，可以是电性，机械或其它的形式。

上述作为分离部件说明的单元可以是或者也可以不是物理上分开的，作为单元显示的部件可以是或者也可以不是物理单元，即可以位于一个地方，或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本实施例方案的目的。

另外，在本申请各个实施例中的各功能单元可以集成在一个处理单元中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个单元中。上述集成的单元既可以采用硬件的形式实现，也可以采用软件功能单元的形式实现。

集成的单元如果以软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本申请的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的全部或部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，包括多指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行本申请各个实施例的方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器(Read-Only Memory，简称ROM)、随机存取存储器(Random Access Memory，简称RAM)、磁碟或者光盘等各种可以存储程序的介质。

以上参照附图说明了本申请实施例的优选实施例，并非因此局限本申请实施例的权利范围。本领域技术人员不脱离本申请实施例的范围和实质内所作的任何修改、等同替换和改进，均应在本申请实施例的权利范围之内。

Claims

1.一种API接口访问方法，其特征在于，所述方法包括：

获取Web Service接口请求；其中，所述Web Service接口请求为SOAP协议请求，所述Web Service接口请求包含XML请求报文；

根据所述Web Service接口请求，获取待访问的API接口的接口信息；其中，所述API接口为REST协议接口，所述API接口的接口信息包括API接口类名和API实现类类名；

发送所述REST请求到所述API接口；

其中，所述根据所述Web Service接口请求，获取待访问的API接口的接口信息，包括：根据所述Web Service接口请求的XML请求报文，获取请求路径；根据所述请求路径，获取所述API接口的API接口类名和API实现类类名；

根据所述API接口类名和API实现类类名，用Java反射机制，解析出所述API接口的对应的接口结构描述信息；

所述接口结构描述信息包括入参结构信息和出参结构信息；其中，所述入参结构信息包括入参方法信息和入参类型信息，所述出参结构信息包括出参方法信息和出参类型信息；

2.根据权利要求1所述的API接口访问方法，其特征在于，所述根据所述接口结构描述信息，将所述Web Service接口请求转换成REST请求，包括：

解析所述XML请求报文，得到第一对象节点值；

根据所述接口结构描述信息，构建JSON对象；

根据所述主体信息，组装成所述REST请求。

3.根据权利要求1所述的API接口访问方法，其特征在于，所述解析所述XML请求报文，得到第一对象节点值，包括：

4.根据权利要求1至3中任意一项所述的API接口访问方法，其特征在于，所述获取WebService接口请求之前，还包括：

监听已实现平台预设注解规则注解的API接口实例；

5.根据权利要求1至3中任一项所述的API接口访问方法，其特征在于，所述获取WebService接口请求之前，还包括：

根据所述WSDL描述信息，组装得到所述Web Service接口请求。

6.根据权利要求5所述的API接口访问方法，其特征在于，所述API接口的WSDL描述信息由以下方式获取得到：

监听已实现平台预设注解规则注解的API接口实例；

获取并存储监听到的所述API接口实例的请求路径；

7.根据权利要求6所述的API接口访问方法，其特征在于，所述API接口的接口信息包括API接口类名；

识别所述API接口实例的请求路径，得到所述API接口类名；

8.根据权利要求7所述的API接口访问方法，其特征在于，所述根据所述接口结构描述信息和预设的目标格式模板，构建所述API接口的WSDL描述信息，包括：

其中，所述目标格式为XML格式。

9.根据权利要求1、2、3、6、7、8中任意一项所述的API接口访问方法，其特征在于，所述发送所述REST请求到所述API接口之后，还包括：

获取来自所述API接口的JSON响应报文；

根据所述JSON响应报文，解析得到响应主体信息；

获取预设的XML响应报文模板；

将所述XML响应报文发送给Web Service请求方。

10.根据权利要求1、2、3、6、7、8中任意一项所述的API接口访问方法，其特征在于，还包括：

11.一种API接口描述转换方法，其特征在于，包括：

监听已实现平台预设注解规则注解的API接口实例；所述API接口为REST协议接口；

获取并存储监听到的所述API接口实例的请求路径；

根据所述API接口实例的请求路径，得到所述API接口的接口信息；其中，所述API接口的接口信息包括API接口类名；

根据所述接口结构描述信息和预设的目标格式模板，构建所述API接口的WSDL描述信息；

其中，所述根据所述API接口实例的请求路径，得到所述API接口的接口信息，包括：

识别所述API接口实例的请求路径，得到所述API接口类名；

12.根据权利要求11所述的接口描述转换方法，其特征在于，所述根据所述接口结构描述信息和预设的目标格式模板，构建所述API接口的WSDL描述信息，包括：

其中，所述目标格式为XML格式。

13.一种API接口访问装置，其特征在于，包括：

第一模块，用于获取Web Service接口请求；其中，所述Web Service接口请求为SOAP协议请求，所述Web Service接口请求包含XML请求报文；

第二模块，用于根据所述Web Service接口请求，获取待访问的API接口的接口信息，所述API接口的接口信息包括API接口类名和API实现类类名；具体的：根据所述Web Service接口请求的XML请求报文，获取请求路径；根据所述请求路径，获取所述API接口的API接口类名和API实现类类名；

第三模块，用于根据所述接口信息得到所述API接口对应的接口结构描述信息；具体的：根据所述API接口类名和API实现类类名，用Java反射机制，解析出所述API接口的对应的接口结构描述信息；所述接口结构描述信息包括入参结构信息和出参结构信息；其中，所述入参结构信息包括入参方法信息和入参类型信息，所述出参结构信息包括出参方法信息和出参类型信息；

所述根据所述API接口类名和API实现类类名，用Java反射机制，解析出所述API接口的对应的接口结构描述信息，包括：根据所述API接口类名，用Java反射机制获取对应的入参方法信息和出参方法信息；根据所述API实现类类名和所述入参方法信息、出参方法信息，用Java反射机制获取对应的入参类型信息和出参类型信息；根据所述入参类型信息和出参类型信息，形成所述接口结构描述信息；

第五模块，用于发送所述REST请求到所述API接口。

14.一种电子设备，其特征在于，所述电子设备包括存储器和处理器，所述存储器存储有计算机程序，所述处理器执行所述计算机程序时实现权利要求1至10任意一项所述的API接口访问方法、或权利要求11至12中任意一项所述的API接口描述转换方法。

15.一种计算机可读存储介质，所述存储介质存储有计算机程序，其特征在于，所述计算机程序被处理器执行时实现权利要求1至10任意一项所述的API接口访问方法、或权利要求11至12中任意一项所述的API接口描述转换方法。