1. 使用须知
API 网关上,创建 API 之前要创建分组,一个分组下可以有多个 API。也就是说一项服务,可以包装成一个分组,一项服务中的多个功能接口分别是这个分组下的多个 API。
下面以一个 API 配置流程作为例子,让您更清晰地了解如何开放 API 并接入 API 网关。
假如数据市场开放一个服务。
- 服务名称:已开放的 API 服务信息查询。
- 服务描述:您通过调用 API 可以查询已经开放的 API 的列表、详细信息等。
例1:Path 中没有动态参数。
例2:Path 中有动态参数。
后端前端的灵活映射:
前端:您调用 API 时,API 请求从您到网关的部分。
后端:请求到达网关后,网关到实际后端服务的部分。
- 后端host ≠ 前端域名。
- 后端path ≠ 前端 path。
-
客户传入参数的位置和名称 ≠ 实际后端服务接收参数的位置和名称(注意 body 只能前后端都为二进制或者都为 form)。
API 网关可以做全方位的前后端映射。
那么上面这个例子该要怎么配置,基本步骤流程如下(以例 2 为例):