简洁配置型rest接口管理与消息转换方法和装置制造方法及图纸

本发明专利技术涉及数据处理技术领域，尤其涉及一种简洁配置型rest接口管理与消息转换方法和装置，通过源API接口注册组件，管理源API接口；通过能力接口配置组件，实现根据源API定制新能力，基于Camel框架技术，采用XML格式的路由DSL，并自定义各种报文格式转换处理器，耗时计算处理器，来达到路由的生成、发布、管理以及接口请求响应耗时的计算与打印输出的目的。打造一个易于集成的SDK或微服务组件，为需要进行简单rest接口管理、参数裁剪或消息转换，提供一种简洁、高效、易于集成的解决方法。易于集成的解决方法。易于集成的解决方法。

【技术实现步骤摘要】
简洁配置型rest接口管理与消息转换方法和装置


[0001]本专利技术涉及数据处理
，尤其涉及一种简洁配置型rest接口管理与消息转换方法和装置。

技术介绍

[0002]在企业级应用系统建设中，往往存在诸多的内外部交互类接口，通常有很多接口作为一个公共服务资源，并不针对某一个具体调用方系统，因此会存在许多调用方系统并不需要的接口字段，反而给接口使用方的开发或维护造成困扰。一种常见的解决方案是接入企业服务总线ESB，ESB提供了协议转换、消息增强、消息转换等一系列非常实用的能力，确实能够很好的解决上述问题。然而ESB作为一个企业应用集成设施，需要提供专有的软硬件资源来进行部署安装，以及配备专门的运维人员，无形中反而又增加了运行成本。特别是在去中心化，微服务化的今天，接口基本都采用了restful标准协议，往往不会再采用这种重量级的集中式ESB服务总线，无法解决消息增强或转换的问题，这就需要实现一种简易的可以快速的集成此rest接口管理能力至应用或服务中的设备。

技术实现思路

[0003]本专利技术提供了一种简洁配置型rest接口管理与消息转换方法和装置，打造一个易于集成的SDK或微服务组件，为需要进行简单rest接口管理、参数裁剪或消息转换，提供一种简洁、高效、易于集成的解决方法。
[0004]为了实现本专利技术的目的，所采用的技术方案是：简洁配置型rest接口管理与消息转换方法，方法包括如下步骤：S1、提供可视化的源API接口注册组件，实现源API接口注册和维护；S2、提供可视化的能力接口配置组件，选择源API接口，勾选编辑需要的出入参数字段，维护配置请求头响应头信息，实现能力接口的维护管理；S3、能力接口的发布与停用：通过接口路由DSL生成工具，创建路由DSL文本字符串，提供路由加载和卸载，以及路由转发和报文转换能力；S4、实现能力接口及源API接口的请求响应耗时计算与日志输出。
[0005]作为本专利技术的优化方案，在步骤S1中，具体实现步骤为：S1
‑
1、创建源API接口表、注册入参表、注册出参表、注册请求头表和注册响应头表，用于存储注册的源API接口数据；S1
‑
2、实现源API接口注册组件界面，提供源API接口分页查询，源API接口详细信息查看、编辑和删除；S1
‑
3、支持swagger文档的导入，通过解析标准的swagger文档，实现源API接口信息读取与快速注册配置。
[0006]作为本专利技术的优化方案，在步骤S2中，具体实现步骤为：S2
‑
1、参照步骤S1
‑
1创建对应的能力接口表、能力入参表、能力出参表、能力请求
头表和能力响应头表，用于存储根据注册的源API接口发布的能力接口；S2
‑
2、通过选择源API接口来创建能力接口配置界面，提供能力接口分页查询，能力接口详细信息查看、编辑和删除，并在页面上提供能力接口的发布和停用按钮。
[0007]作为本专利技术的优化方案，在步骤S3中，具体实现步骤为：S3
‑
1、创建接口路由DSL生成工具，根据能力接口配置组件配置的能力接口信息，生成路由DSL字符串；S3
‑
2、创建路由服务类，加载路由DSL文本生成路由服务，或者停用路由服务；S3
‑
3、创建Http请求报文类型转换处理器，完成raw报文体类型的能力接口向form
‑
data类型转换，以适配请求体为form
‑
data类型的源API接口；S3
‑
4、创建请求头和响应头与报文体格式转换处理器，根据能力接口配置的出入参数及头信息中的jsonPath，完成数据的获取与填充，实现格式转换；S3
‑
5、Camel组件根据路由DSL信息，完成路由的转发。
[0008]作为本专利技术的优化方案，在步骤S4中，具体实现步骤为：S4
‑
1、编写耗时计算处理器，用于计算接口响应耗时；S4
‑
2、实现能力接口和API接口请求计时埋点，以及在能力接口和API接口后分别装载耗时计算处理器，并在嵌入Camel的log组件实现格式化审计日志输出。
[0009]作为本专利技术的优化方案，在步骤S4
‑
2中，具体实现步骤为：S4
‑2‑
1：向耗时计算处理器CalcElapsedTimeProcess函数库传入headerKey，从请求头中header中获取记录的时间，再用当前系统时间与记录的时间相减，获得时间差值毫秒数，即为耗时，并写回header中；当前系统时间即操作系统的当前时间。
[0010]S4
‑2‑
2：在XML格式路由DSL的from端点后，通过Camel的setHeader组件往header中以能力接口编码为key写入当前系统时间；S4
‑2‑
3：在路由DSL最后加入耗时计算处理器，用来计算能力接口响应耗时；追加Camel的log组件打印能力接口的编码、响应耗时、响应状态码；S4
‑2‑
4：在路由DSL的to端点前，通过Camel的setHeader组件往header中以能力接口编码为key写入当前系统时间；在路由DSL的to端点后加入耗时计算处理器，用来计算源API接口响应耗时；再追加Camel的log组件打印to端点对应的源API接口的编码、响应耗时、响应状态码。
[0011]为了实现本专利技术的目的，所采用的技术方案是：简洁配置型rest接口管理与消息转换装置，装置包括源API接口注册模块、能力接口配置模块、接口路由DSL生成模块、能力接口发布/停用模块和审计日志模块，源API接口注册模块提供源API接口的注册管理；能力接口配置模块提供使用源API接口重定义参数发布能力接口以及对能力接口的各项管理，并提供能力接口的发布和停用操作入口；接口路由DSL生成模块提供根据能力接口配置信息，并整合各种请求处理器，生成Camel标准的XML格式接口路由DSL字符串；能力接口发布/停用模块使用接口路由DSL生成模块生成的路由DSL提供路由的查看和停用；审计日志模块提供能力接口及源API接口请求响应耗时的计算，以及审计日志的打印输出。
[0012]本专利技术具有积极的效果：本专利技术通过简洁配置型rest接口管理与消息转换方法和装置，实现对已有通用型接口，快速配置转换成符合特定业务需要的新接口，便于接口调用方理解、开发、维护。同时在发布的新接口中，可通过请求头配置如外部API接口Token鉴权
参数等信息，以及在接口路由中实现接口审计日志的输出，简化接口的调用，以及为接口的调用统计监控提供必要的数据支持，适用于现今去中心化的restful协议的跨服务交互的应用场景。
附图说明
[0013]为了更清楚地说明本专利技术实施例的技术方案，下面将对实施例中所需要使用的附图作简单地介绍，应当理解，以下附图仅示出了本专利技术的某些实施例，因此不应被本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.简洁配置型rest接口管理与消息转换方法，其特征在于：所述方法包括如下步骤：S1、提供可视化的源API接口注册组件，实现源API接口注册和维护；S2、提供可视化的能力接口配置组件，选择源API接口，勾选编辑需要的出入参数字段，维护配置请求头响应头信息，实现能力接口的维护管理；S3、能力接口的发布与停用：通过接口路由DSL生成工具，创建路由DSL文本字符串，提供路由加载和卸载，以及路由转发和报文转换能力；S4、实现能力接口及源API接口的请求响应耗时计算与日志输出。2.根据权利要求1所述的简洁配置型rest接口管理与消息转换方法，其特征在于：在步骤S1中，具体实现步骤为：S1
‑
1、创建源API接口表、注册入参表、注册出参表、注册请求头表和注册响应头表，用于存储注册的源API接口数据；S1
‑
2、实现源API接口注册组件界面，提供源API接口分页查询，源API接口详细信息查看、编辑和删除；S1
‑
3、支持swagger文档的导入，通过解析标准的swagger文档，实现源API接口信息读取与快速注册配置。3.根据权利要求2所述的简洁配置型rest接口管理与消息转换方法，其特征在于：在步骤S2中，具体实现步骤为：S2
‑
1、参照步骤S1
‑
1创建对应的能力接口表、能力入参表、能力出参表、能力请求头表和能力响应头表，用于存储根据注册的源API接口发布的能力接口；S2
‑
2、通过选择源API接口来创建能力接口配置界面，提供能力接口分页查询，能力接口详细信息查看、编辑和删除，并在页面上提供能力接口的发布和停用按钮。4.根据权利要求3所述的简洁配置型rest接口管理与消息转换方法，其特征在于：在步骤S3中，具体实现步骤为：S3
‑
1、创建接口路由DSL生成工具，根据能力接口配置组件配置的能力接口信息，生成路由DSL字符串；S3
‑
2、创建路由服务类，加载路由DSL文本生成路由服务，或者停用路由服务；S3
‑
3、创建Http请求报文类型转换处理器，完成raw报文体类型的能力接口向form
‑
data类型转换，以适配请求体为form
‑
data类型的源API接口；S3
‑
4、创建请求头和响应头与报文体格式转换处理器，根据能力接口配置的出入参数及头信息中的jsonPath，完成数据的获取与填充，实现格式转换；S3
‑
5、Cam...

【专利技术属性】
技术研发人员：丁振华，
申请(专利权)人：中博信息技术研究院有限公司，
类型：发明
国别省市：