发布你的第一个 API
本教程介绍如何在 API7 企业版中发布并验证一个简单的 API。你将完成以下步骤:
前提条件
- 安装 API7 企业版。
- 根据你的环境部署网关实例:
- 要在 Kubernetes 中部署 API7 网关并使用 Ingress Controller,请完成在 Kubernetes 上部署网关和 Ingress Controller。
- 要在 Docker 中部署 API7 网关,请按照新增网关实例中的 Docker 步骤操作。
创建服务和路由
- 控制台
- ADC
- Ingress Controller
创建服务
- 从侧边栏选择网关组下的已发布服务,然后点击新增服务。
- 选择手动新增。
- 在新增服务对话框中,执行以下操作:
- 在名称字段中输入
httpbin。 - 在服务类型字段中选择
HTTP(七层代理)。 - 在上游协议字段中选择
HTTP。 - 在如何查找上游字段中选择
使用节点。 - 点击新增节点。
- 在新增节点对话框中,执行以下操作:
- 在主机字段中输入
httpbin.org。 - 在端口字段中输入
80。 - 在权重字段中输入
100。
- 在主机字段中输入
- 在名称字段中输入
- 点击新增。这将创建一个处于“无版本”状态的新服务。
创建路由
- 点击上一步创建的服务,然后点击新增路由。
- 在新增路由对话框中,执行以下操作:
- 在名称字段中输入
get-ip。 - 在路径字段中输入
/ip。 - 在方法字段中选择
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 时,建议优先使用 Gateway API,而不是 Ingress 资源,以获得更好的灵活性和可扩展性。
要将请求转发到 httpbin.org,请创建路由清单文件(同时也会创建服务):
- Gateway API
- Ingress
- APISIX CRD
httpbin-route.yaml
apiVersion: v1
kind: Service
metadata:
namespace: api7
name: httpbin-external-domain
spec:
type: ExternalName
externalName: httpbin.org
---
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
namespace: api7
name: getting-started-ip
spec:
parentRefs:
- name: apisix
rules:
- matches:
- path:
type: Exact
value: /ip
backendRefs:
- name: httpbin-external-domain
port: 80
httpbin-route.yaml
apiVersion: v1
kind: Service
metadata:
namespace: api7
name: httpbin-external-domain
spec:
type: ExternalName
externalName: httpbin.org
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
namespace: api7
name: getting-started-ip
spec:
ingressClassName: apisix
rules:
- http:
paths:
- path: /ip
pathType: Exact
backend:
service:
name: httpbin-external-domain
port:
number: 80
httpbin-route.yaml
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
namespace: api7
name: httpbin-external-domain
spec:
ingressClassName: apisix
externalNodes:
- type: Domain
name: httpbin.org
---
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
namespace: api7
name: getting-started-ip
spec:
ingressClassName: apisix
http:
- name: getting-started-ip
match:
paths:
- /ip
upstreams:
- name: httpbin-external-domain
将配置应用到集群:
kubectl apply -f httpbin-route.yaml
验证 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"
}
首先,通过端口转发将服务端口暴露到本地:
kubectl port-forward svc/apisix-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文件。 - 在上游协议和服务类型字段中保留默认设置
HTTP。 - 在如何查找上游字段中保留默认设置
使用节点。 - 点击新增节点。
- 在新增节点对话框中,执行以下操作:
- 在主机字段中输入
httpbin.org。 - 在端口字段中输入
80。 - 在权重字段中输入
100。
- 在主机字段中输入
- 点击下一步。
- 在 OpenAPI 3.0 规范字段中上传
- 点击新增。这将创建一个处于“无版本”状态的新服务。基本信息和标签会被导入,OpenAPI 文件中的所有路径都会转换为服务中的路由。
以下互动演示介绍如何通过导入 OpenAPI 添加服务。点击并按照演示步骤操作,可以进一步了解如何在 API7 企业版中使用该功能。