创建你的第一个 API
本教程介绍如何在 API7 网关上启动并验证一个简单的 API。你将完成以下步骤。
前提条件
启动一个示例上游服务
如果你在 Kubernetes 上运行 API7 网关,请在本节中将 httpbin 应用部署到集群,作为上游服务示例。否则,请跳到下一节,使用托管的 httpbin 应用作为上游。
启动一个 httpbin 应用作为示例。
kubectl run httpbin --image kennethreitz/httpbin --port 80
你应看到 pod/httpbin created 响应。
通过服务暴露应用的 80 端口。
kubectl expose pod httpbin --port 80
你应看到 service/httpbin exposed 响应。
创建服务与路由
- 控制台
- ADC
- Ingress Controller
创建服务
- 在侧边栏选择目标网关组下的 已发布服务,然后点击 新增服务。
- 选择 手动新增。
- 在 新增服务 对话框中完成以下操作。
- 在 名称 字段中输入
httpbin。 - 在 服务类型 字段中选择
HTTP(七层代理)。 - 在 上游 Scheme 字段中选择
HTTP。 - 在 如何找到上游 字段中选择
使用节点。 - 点击 新增节点。
- 在 新增节点 对话框中完成以下操作。
- 在 主机 字段中输入
httpbin.org。 - 在 端口 字段中输入
80。 - 在 权重 字段中输入
100。
- 在 主机 字段中输入
- 在 名称 字段中输入
- 点击 新增。新建的服务处于“无版本”状态。
创建一条路由
- 点击刚刚创建的服务,然后点击 新增路由。
- 在 新增路由 对话框中完成以下操作。
- 在 名称 字段中输入
get-ip。 - 在 路径 字段中输入
/ip。 - 在 HTTP 方法 字段中选择
GET。 - 点击 新增。
- 在 名称 字段中输入
以下交互式演示介绍如何创建无版本服务。你可以按照演示中的步骤了解如何在 API7 企业版中使用此功能。
创建以下配置文件。
adc.yaml
services:
- name: httpbin
upstream:
name: default
scheme: http
nodes:
- host: httpbin.org
port: 80
weight: 100
routes:
- uris:
- /ip
name: get-ip
methods:
- GET
将配置同步到 API7 企业版。
adc sync -f adc.yaml
创建一个配置文件,其中包含 API7 Ingress Controller 的路由自定义资源。
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: get-ip
namespace: api7
spec:
http:
- name: get-ip
match:
paths:
- /ip
backends:
- serviceName: httpbin
servicePort: 80
将配置应用到集群。
kubectl apply -f httpbin-route.yaml
你应看到以下响应。
apisixroute.apisix.apache.org/httpbin-route created
验证 API
- 控制台
- ADC
- Ingress Controller
向路由发送请求。
curl "http://127.0.0.1:9080/ip"
你应看到以下响应。
{
"origin": "127.0.0.1"
}
向路由发送请求。
curl "http://127.0.0.1:9080/ip"
你应看到以下响应。
{
"origin": "127.0.0.1"
}
在控制台的 已发布服务 中,你应看到名为 api7_httpbin_80 的服务。
首先,通过端口转发将服务端口暴露到本地机器。
kubectl port-forward svc/api7-ee-3-gateway-gateway 9080:80 &
上述命令会在后台运行,将 api7-ee-3-gateway-gateway 服务的 80 端口映射到本地机器的 9080 端口。
向路由发送请求。
curl "http://127.0.0.1:9080/ip"
你应看到类似以下内容的响应。
{
"origin": "127.0.0.1"
}
现在,你的第一个 API 已经开始运行。
导入 OpenAPI 以添加 API
你也可以导入 OpenAPI 3.0 规范来添加 API。
创建服务
- 在侧边栏选择目标网关组下的 已发布服务,然后点击 新增服务。
- 选择 导入 OpenAPI。
- 在 新增服务 对话框中完成以下操作。
- 在 OpenAPI 3.0 规范 字段中上传
httpbin.yaml文件。 - 在 上游 Scheme 和 服务类型 字段中保留默认设置
HTTP。 - 在 如何找到上游 字段中保留默认设置
使用节点。 - 点击 新增节点。
- 在 新增节点 对话框中完成以下操作。
- 在 主机 字段中输入
httpbin.org。 - 在 端口 字段中输入
80。 - 在 权重 字段中输入
100。
- 在 主机 字段中输入
- 点击 下一步。
- 在 OpenAPI 3.0 规范 字段中上传
- 点击 新增。新建的服务处于“无版本”状态。基本信息和标签会被导入,OpenAPI 文件中的所有路径都会转换为该服务的路由。
以下交互式演示介绍如何导入 OpenAPI 来添加服务。你可以按照演示中的步骤了解如何在 API7 企业版中使用此功能。