API 统一网关
API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，旨在帮助企业统一管理对内外开放的 API，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时...关于 API 网关详细的功能介绍和使用指南，请参见 SOFAStack API 统一网关。
HTTP 转 SOFARPC 入门
左侧导航栏单击 API统一网关>API 发布>系统集群。在系统集群列表页面，单击右上方的 创建系统集群 按钮。在新弹出窗口中，您需要配置以下信息：系统集群名称：必填，用于识别系统集群。根据本示例，此处可使用 sofarpc。协议类型：支持 ...
创建系统集群
DUBBO 协议类型 进入 金融分布式架构页面，左侧导航栏选择 API 统一网关>API 发布>系统集群。在系统集群列表页面，单击右上方的 创建系统集群。在新弹出窗口中，配置基础信息：系统集群名称：必填，用于识别系统集群，支持英文字母、中文、...
HTTP API 入门
在左侧导航栏单击 API 统一网关>API 发布>系统集群。在系统集群列表页面，单击 创建系统集群 按钮。在新弹出窗口中，您需要配置以下信息：系统集群名称：必填，用于识别系统集群。本示例使用 helloserver。协议类型：根据本示例，选择 ...
产品简介
API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，提供 API 托管服务，帮助企业开发者将内部系统的接口封装成 API 开放出去，供外部应用调用，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时保障内部系统的安全性。...
应用场景
异构系统集成场景 统一集成 降低企业内部系统集成的成本，无缝连接不同的软件应用程序。遗留系统兼容 允许 IT 团队选择最适合技术栈，在转型过程中并且可以兼容遗留系统，加速企业转型升级。集中管理 IT 团队可以从更集中的位置访问所有...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
产品架构
API 网关主要由 GW Controller 和 Mosng 两个组件构成，GW Controller 将数据推送给 Mosng 后，Mosng 开始对外提供服务。本文主要结合这两个组件介绍 API 网关架构。API Gateway 系统主要由以下组件构成：GW Controller：网关控制台，负责...
产品优势
多种客户端接入支持 同一个 API 发布后，既支持 mPaaS 移动端 iOS 和 Android 的应用接入，也支持非移动端小程序、H5、Web、后端应用等应用接入。多协议/多语言异构集成 支持不同语言，不同技术栈实现的业务系统之间进行无缝集成，支持协议...
概述
本文主要介绍网关的几个...数据加密 统一网关提供了对客户端与网关之间传输的数据进行加密的能力，支持 RSA、ECC、国密 三种加密算法，保证数据传输过程中的安全性。详情参见 数据加密。说明 目前仅支持对 HTTP 类型的 API 调用进行数据加密。
功能特性
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
概述
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
产品计费
计费方式 API 网关目前是按接口调用数进行计费，是一种先使用后付费的计费方式，即根据单月内某个用户使用网关，进行有效调用 API 的请求累计次数进行阶梯计费，此外不收取其他任何费用。计费规则 网关以每小时作为计费周期，在计费周期内...
功能总览
网关主要功能模块如下：API 全生命周期管理 快速构建多种协议类型的 API 支持按需导入导出 API 多版本管理满足企业迭代需求 统一接入 支持多种方式创建路由规则 通过参数映射实现多部门参数统一规范 支持创建多种参数类型的外部授权 API ...
结构体说明
page_info ApiInfoVO 名称 类型 是否必填 示例 描述 api_cache_model ApiCacheVO 否-API 缓存模型 api_group_id STRING 否 api_group_id1 API 分组标识 api_group_name STRING 否 api_group_name1 所属 API 分组名称 api_id STRING 否 8...
创建参数映射
API 网关支持参数映射。参数映射是将请求或响应参数中的不规范或者不统一的参数，映射为符合客户端或者服务端规范的参数。该功能常用于多部门协同、实现参数统一规范，以及实现统一错误码等场景。操作步骤 进入 API 网关控制台页面，在左侧...
跨域设置
本文主要介绍需要在 API 网关中如何进行双网关跨域设置。说明 只有管理员角色才可以进行跨域设置，如何配置角色权限请联系蚂蚁技术支持团队。添加 workspace 登录 API 网关控制台。在左侧导航栏单击 全局设置>跨域设置。说明 仅 双网关跨域...
导入导出 API
您可以在 API 网关控制台上以 JSON 文件的形式对 API 进行批量导入及导出。说明 为减少操作耗时，建议一次性导入/导出 API 的数量不超过 100 个。导入 API 的 JSON 格式请参见模板 API Json 文件格式。批量导出 API 在 API 发布>API 管理 ...
接入 SDK
要使用 SDK 访问 API 网关的 OpenAPI，您必须引入以下两个 SDK：基础 SDK：是 SOFAStack 中通过 SDK 调用任何 API 时都必须依赖的 SDK。基础 SDK-><dependency><groupId>cn.com.antcloud.api</groupId><artifactId>antcloud-api-sdk...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
API 流量治理
在 API 详情页，您可以对该 API 进行流量治理，即配置限流与缓存。限流 限流指对网关到后端集群的请求进行限制。操作步骤如下：说明 目前 API 网关仅支持单机限流，即对经过网关单容器（非集群）到后端集群的请求进行限制。在 API 详情页，...
API 缓存配置
如果一个接口本身是幂等的，并且返回值在一定时间内不会发生变化，那么可以在 API 网关上配置缓存。当前支持的缓存最长时间为 5 分钟。缓存的 key 可以从 Header、Cookie、QueryString 或 Body 中选择。如果选择 Body，Body 必须是一个 ...
路径匹配规则
API 网关支持 绝对匹配、参数匹配 和 前缀匹配 三种路径匹配规则。绝对匹配 绝对匹配，表示只有请求的路径和配置的路径完全一样时才能匹配成功。示例 例如，当前 API 的匹配规则为 GET/path。请求示例：请求一：curl ...
创建数据模型
API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时，可以直接引用数据模型的配置参数，提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API ...
使用外部授权 API
API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。如下图所示，步骤 2 即为...
外部授权
API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。外部授权服务编写须知 您...
创建应用
在调用 API 前，订阅者需在订阅端创建一个应用。这个应用就是一个订阅对象，API 发布者给该应用授权后，便可将该应用和 API 关联在一起。操作步骤 登录 API 网关控制台。在左侧导航栏中单击 API 订阅>应用管理，进入应用列表。单击应用列表...
SOFARPC 客户端接入
前置条件 在进行本地订阅方应用开发、接入网关前，需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体...
创建授权对象
在 API 订阅者创建应用后，API 发布者可根据应用创建授权对象。操作步骤 登录 API 网关控制台。在左侧导航栏中单击 API 发布>授权管理，进入授权列表。单击授权列表右上方的 创建授权对象。在弹出的 创建授权对象 窗口中，选择或输入相关...
创建 CORS 规则
操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>CORS 管理，进入 CORS 配置 页面。单击 CORS 列表右上方的 创建 CORS。在弹出的 新建 CORS 窗口中，选择或输入相关信息：CORS 名称：必填，输入 CORS 的名称用以识别 CORS ...
创建路由规则
在网关接收到请求后，会通过路由规则将请求路由到后端系统，您可在此创建相关的路由规则。操作步骤 登录 API 网关控制台页面。在左侧导航栏中单击 路由规则，进入路由规则列表。单击路由规则列表右上方的 创建路由规则。在弹出的 创建路由...
发送 HTTP 请求（NodeJS）
前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体获取方法，参见...
导入数据模型
为了方便用户快速生成数据模型，API 网关支持通过 Proto 文件和 Swagger 文件来快速导入数据模型。操作步骤 登录 API 网关控制台。在左侧导航栏单击 API 发布>数据模型，进入数据模型页面。在页面右上角单击 导入数据模型，在弹出的窗口中...
发送 HTTP 请求（Java）
应用的访问密钥（Access Key/Secret Key）API 的域名地址（host）、请求路径（path）、方法（method）、请求体（body）操作步骤 API 网关提供了一个 Java SDK，即 gateway-sdk。该 SDK 集成了加签、加密、验签的逻辑，同时默认支持序列化和...
错误码
为方便您在使用过程中进行问题定位，本文将介绍网关的错误码信息。简介 网关提供了错误码及相关解决方案。一个错误码的完整信息包括结果码、HTTP 状态码、memo 和 tips。结果码是网关定义的返回码，用来标识一个请求的响应状态。每一个结果...
数据加密
API 网关提供客户端与网关之间数据加密的能力，支持 RSA、ECC、国密三种加密算法，保证数据传输过程中的安全性。说明 目前仅支持对 HTTP 类型的 API 调用进行数据加密。使用流程 根据加密算法，生成密钥。网关管控平台创建应用并开启加密...
创建 API 分组
API 分组将网关上的 API 按照业务需求进行分组管理。同一分组下的 API 共享一个域名地址。您可以通过以下任一方式创建 API 分组：在分组列表中创建 API 分组 登录 API 网关控制台。在左侧导航栏单击 API 发布>API 分组，进入分组列表。单击...
配置参数映射模板
API 网关支持通过配置参数映射模板的方式对请求和响应数据进行自动化修改。本文将详细介绍参数映射模板的配置语法及注意事项等。模板示例 说明 后端 SOFAREST 协议已支持绑定参数映射。请求模板#请求 body {"x":{"name":"jack"},"y":{"z":...
发送 HTTP 请求（C#）
前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体获取方法，参见...
- 产品推荐
- 这些文档可能帮助您