全网唯一标准王
(19)中华 人民共和国 国家知识产权局 (12)发明 专利申请 (10)申请公布号 (43)申请公布日 (21)申请 号 202111517719.9 (22)申请日 2021.12.13 (71)申请人 四川启睿 克科技有限公司 地址 610000 四川省成 都市中国 (四川) 自 由贸易试验区成都高新区天府四街 199号1栋33层 (72)发明人 杨万宝  (74)专利代理 机构 四川省成 都市天策商标专利 事务所(有限合 伙) 51213 代理人 刘兴亮 (51)Int.Cl. H04L 12/66(2006.01) H04L 9/40(2022.01) H04L 67/565(2022.01) H04L 45/02(2022.01) (54)发明名称 一种API网关系统及运行方法 (57)摘要 本发明公开了一种API网关系统及运行方 法, 通过将业务API拆分, 使用界面化的配置, 并 通过参数转换器, 将开发者的API路由配置转化 成网关识别的路由策略, 并使其动态生效, 为各 种场景下开放API提供支撑, 可建立API生态, 将 API开放给合作伙伴、 开发者, 实现企业核心能力 赋能; 支持将API适配多端, 如: 移动端、 互联网, 实现系统前后端分离; 支持内部系统整合, 模块 化、 微服务化。 权利要求书2页 说明书5页 附图1页 CN 114205191 A 2022.03.18 CN 114205191 A 1.一种API网关系统, 其特 征在于, 包括: API管理模块, 用于API定义信息、 API授权、 API 流量控制、 API访问控制、 API发布; 参数转换模块, 用于将API管理模块收集的API定义信息转换为Spring  Cloud Gateway 的路由策略信息; 网关引擎模块, 用于路由断言、 API鉴权、 API参数校验、 API参数重写、 API转发、 API限流 及熔断。 2.如权利要求1所述的一种API网关系统, 其特征在于, 所述API定义信息包括客户端 API请求信息、 认证方式、 API 服务端配置信息、 API返回配置信息、 API超时熔断; 所述API授权, 指将API授权给相关客户端访问; 所述API流量控制信息包括, 流 量控制策略和策略与API绑定关系; 所述API访问控制信息包括, 访问控制策略和策略与API绑定关系; 所述API发布, 指将配置好的API路由信息经转换器处理后的数据动态更新到引擎路由 表中。 3.如权利要求1所述 的一种API网关系统, 其特征在于, 所述Spring  Cloud Gateway的 路由策略信息, 包括策 略ID、 转发URI、 路 由断言集合、 过滤器集合和路由策略执行优先级; 所述Spring  Cloud Gateway的路由模型, 包括路由ID、 路由断言集合、 路由过滤器集合、 路 由转发的目标URI、 路由执行顺序、 路由断言模型和过滤器模型; 路由断言模型包括 断言关 键字Name和断言规则关键字args, 过滤器模型包括过滤器 关键字Name和对应 路由规则关键 字args。 4.如权利要求3所述的一种API网关系统, 其特征在于, 所述路由断言模型, 将console 控制台配置的请求基础定义对应的path, method设置 到路由断言模型中。 5.如权利要求3所述的一种API网关系统, 其特征在于, 所述过滤器模型, 将console控 制台设置的认证方式、 访问控制策 略、 限流、 方法重写、 参数校验、 路径重写、 返回参数定义 策略设置 到过滤器模型中。 6.如权利要求3所述的一种API网关系统, 其特征在于, 所述路由执行顺序, 指为支持通 配、 精确匹配、 正则匹配、 ur l含参数多种断言不互相干扰, 对order数值定义相关规则, 数字 越小执行顺序越靠前, 当从控制台获取到该API需匹配所有子 路径时, 根据路径层 级, order 设置为‑10*层级数, 若为精确匹配则order设置为 ‑10000; 当url包含参数时, 则根据动态参 数多少来设置不同的数字 。 7.如权利 要求3所述的一种 API网关系统, 其特征在于, 所述路由模型根据console控制 台的API存储ID, 设置 路由ID; 根据控制台添加的后端服务地址设置到URI上; 将装配的断言 集合、 过滤器集合、 路由执 行顺序分别设置 到路由模型对应属性上。 8.如权利要求1所述的一种API网关系 统, 其特征在于, 所述路由断言, 根据API请求的 path、 metho d、 host、 header信息去内存 中检索能与之匹配的路由策略, 如无相关匹配则网 关直接给客户端返回异常; 所述API鉴权, 根据所述路由断言匹配上的路由策略确认鉴权类型, 并以此类型对API 请求参数重的认证信息进行 校验, 如校验失败, 网关直接返回401给客户端; 所述API参数校验, 根据所述API鉴权通过后, 按路由策略信息对API请求相关参数进行 校验, 如校验失败, 网关直接给客户端返回相关异常信息;权 利 要 求 书 1/2 页 2 CN 114205191 A 2所述API参数重写, 根据所述路由断言、 API鉴权通过后的路由策略信息, 按相关规则把 API请求的相关参数按规则移位; 所述API转发, 根据所述路由断言、 API鉴权验证通过后, 按照路由策略信息, 将API请求 转发给策略信息中的URI。 9.如权利要求1 ‑8任一项所述的一种API网关系统的运行方法, 其特征在于, 包括以下 步骤: 步骤一、 管理控制台, 进行API定义、 流控策略创建、 访问策略创建、 应用创建、 API授权 及发布; 步骤二、 参数转换模块, 对API管理控制台提交的结构化数据, 进行转换以适配网关引 擎所需的数据格式; 步骤三、 网关引擎模块, 基于Spring  Cloud Gateway自定义过滤器, 以实现路由断言、 API鉴权、 API 参数校验、 API 参数重写、 API 转发、 API限流及熔断。 10.如权利要求9所述的一种API网关系统的运行方法, 其特征在于, 所述步骤一中, 控 制台页面定义API请求、 选择认证方式、 参数转换配置、 转 发目标配置、 服务端响应配置、 API 返回配置信息; 创建流控策略, 涉及API、 APP和用户三个维度; 创建访问策略, 选择允许/禁 止访问, 配置ip段; 创建应用, 将应用appKey、 appSecret提供给客户端; 最后将定义的API与 流控策略、 访问策略绑定, 授权给应用, 再 执行发布操作; 所述步骤二中, 定义一个路由模型, 针对每一个属性做参数转换; 如果涉及多层 断言, 则初始化一个断言集合, 将每个断言模型装配好后, 添加到集合中; 初始化一个过滤器集 合, 再初始 化过滤器模 型, 初始化一个 map, map数据根据 认证方式及后端引擎解析来设置相 关参数; 再将多个过滤器模型数据装配好后, 添加到过滤器集合中; 将前面装配的断言集 合、 过滤器集合、 路由执行顺序分别设置到 路由模型对应属性上, 最后将路由模 型动态更新 到网关引擎中; 所述步骤三中, 网关引擎根据API请求Request中path、 method、 host、 header信息去内 存中检索能与之匹配的路由策略, 如无相关匹配则网关直接给客户端返回异常; 匹配通过 后依次对API请求进 行鉴权、 参数校验、 参数映射、 路由重写处理; 全部通过后请求会被转 发 给后端具体的服务提供者, 后端响应完成后, 再根据路由策略信息, 对返回参数做统一诸如 异常处理、 参数转换操作, 最后转发给客户端, 结束 整个调用过程。权 利 要 求 书 2/2 页 3 CN 114205191 A 3

.PDF文档 专利 一种API网关系统及运行方法

文档预览
中文文档 9 页 50 下载 1000 浏览 0 评论 309 收藏 3.0分
温馨提示:本文档共9页,可预览 3 页,如浏览全部内容或当前文档出现乱码,可开通会员下载原始文档
专利 一种API网关系统及运行方法 第 1 页 专利 一种API网关系统及运行方法 第 2 页 专利 一种API网关系统及运行方法 第 3 页
下载文档到电脑,方便使用
本文档由 人生无常 于 2024-03-18 23:32:16上传分享
友情链接
站内资源均来自网友分享或网络收集整理,若无意中侵犯到您的权利,敬请联系我们微信(点击查看客服),我们将及时删除相关资源。