You need to enable JavaScript to run this app.
导航

新手指引

最近更新时间2023.02.27 18:52:56

首次发布时间2022.01.07 19:21:45

API 网关支持对接函数服务、云服务器、容器服务等多种后端类型,帮助您将后端服务的能力开放出来。本文为您介绍 API 网关的基本使用流程,帮助您快速上手 API 网关。

前提条件

  • 已注册火山引擎账号,并完成实名认证。
  • 已在 API 网关的开服地域创建私有网络及其子网。如果您希望多可用区部署 API 网关,需提前在目标可用区下创建子网。详细操作,请参见 创建私有网络
  • 已提前准备好待对接的后端服务,API 网关当前支持对接火山引擎的 函数服务云服务器 及 容器服务

步骤一:创建实例

使用 API 网关之前,首先需要创建资源相互隔离的网关实例。具体操作可参见 创建实例

步骤二:创建服务

服务是一组路由对外暴露的入口,用于区分流量的来源和协议,实现业务、环境、逻辑租户隔离。每个服务提供一个独立的访问域名,以域名维度管理 API 访问业务。具体操作可参见 创建服务

步骤三(可选):添加 Upstream 来源

如果您需要对接部署于 VKE 集群的 Kubernetes Service,需要提前将待对接的集群添加至网关的 Upstream 来源中,以便网关获取 Kubernetes Service 列表。具体操作可参见 创建 Upstream 来源

步骤四:创建 Upstream

将具有相同功能的后端服务抽象为一个 Upstream,实现路由和后端服务解耦。更灵活地支持后端应用的灰度发布、多版本管理等场景。

步骤五:创建路由

通过创建路由功能,可将符合规则的请求,按照设置的流量权重分发至多个目标 Upstream,满足应用的多版本管理等场景。具体操作可参见 创建路由

后续步骤

至此,您已将后端服务接入 API 网关。您可进一步通过 Postman 等 API 调试工具对业务进行调试,验证业务是否可正常对外提供服务。