发布服务版本
要对已部署的 API 进行版本控制,可以通过 API7 网关将服务版本发布到不同的网关组,避免直接在网关组中修改配置。
通常,API 版本先发布到测试和预发布环境,再发布到生产环境。API7 网关通过网关组隔离这些环境。每个 API 属于一个已发布的服务,同一服务中的 API 共用一个上游。
本教程介绍如何将 httpbin 服务发布到 API7 网关的一个网关组。你将学习以下操作。
- 手动创建服务模板以及通过 OpenAPI 文件创建服务模板。
- 通过配置上游节点和使用服务发现机制来发布服务。
前提条件
- 安装 API7 企业版。
- 确保网关组中至少有一个网关实例。
新增服务模板并添加路由
手动新增
- 控制台
- ADC
- 在左侧导航栏中选择 服务中心, 然后点击 新增服务。
- 选择 手动新增。
- 在表单中执行以下操作:
- 名称 填写
httpbin。 - 服务类型 选择
HTTP (七层代理)。 - 上游 Scheme 选择
HTTP。 - 点击 新增。
- 进入服务内,点击 新增路由。
- 在表单中,执行以下操作:
- 名称 填写
getting-started-anything。 - 路径 填写
/anything/*。 - HTTP 方法 选择
GET。 - 点击 新增。
创建一个 ADC 配置文件,包含服务及其上游和路由:
adc.yaml
services:
- name: httpbin
upstream:
name: httpbin upstream
scheme: http
nodes:
- host: httpbin.org
port: 80
weight: 100
routes:
- uris:
- /anything/*
name: getting-started-anything
methods:
- GET
导入 OpenAPI 文件
控制台和 ADC 都支持导入 OpenAPI v3.0 规范。
在 YAML/JSON 文件中定义你的 API,如下所示:
OpenAPI.yaml
openapi: 3.1.0
info:
title: httpbin
description: "httpbin for the API7 Enterprise Getting Started guides."
version: 1.0.0
paths:
"/anything/*":
get:
tags:
- Anything
summary: Returns anything that is passed into the request.
operationId: getting-started-anything
responses:
"200":
description: Successful Response
content:
application/json:
schema:
type: string
tags:
- name: Anything
description: Return anything that is passed in on the request.
然后在 API7 网关中使用:
- 控制台
- ADC
- 在左侧导航栏中选择 服务中心, 然后点击 新增服务。
- 选择 导入 OpenAPI。
- 在表单中执行以下操作:
- 上传你的 YAML/JSON 文件。
- 上游 Scheme 选择
HTTP。 - 点击 下一步。
- 确认以下信息:
- 名称:来自 OpenAPI 文件的
title。 - 标签:来自 OpenAPI 文件的
tag。 - 描述:来自 OpenAPI 文件的
description。 - 名称:来自 OpenAPI 文件的
title。 - 点击 新增。
使用 ADC 将 OpenAPI 文件转换成 ADC 配置文件:
adc convert openapi -f openapi.yaml -o adc.yaml
发布单个服务
- 控制台
- ADC
- 在左侧导航栏中选择 服务中心, 然后选择之前创建的
httpbin服务。 - 点击 发布新版本。
- 在对话框中选择目标网关组,例如
default,然后点击 下一步。 - 在表单中执行以下操作:
- 新版本 填写
1.0.0。 - 如何找到上游 选择
使用节点。 - 点击 新增节点。在表单中执行以下操作:
- 主机 和 端口 填写
httpbin.org和80。 - 权重 使用默认值
100。 - 点击 新增。
- 主机 和 端口 填写
- 确认服务信息,然后点击 发布。
将上一步中创建的配置文件同步到你的目标网关组,例如 default:
adc sync -f adc.yaml --gateway-group default
批量发布服务
- 控制台
- ADC
-
从侧边栏选择 服务中心,然后点击 批量发布服务。
-
选择你的目标网关组,例如,
default,然后点击 下一步。 -
点击 新增服务。
-
在对话框中,执行以下操作:
- 在 服务 下拉列表中,选择你要发布的服务。
- 新版本 输入
1.0.0。 - 点击 新增。
-
重复上述步骤以添加更多服务。
-
点击 下一步 继续发布服务。
-
在新窗口中,为每个服务执行以下操作:
- 在 如何查找上游 字段中,选择
使用节点。 - 点击 新增节点。在对话框中执行以下操作。
- 主机 和 端口 分别输入
httpbin.org和80。 - 权重 使用默认值
100。 - 点击 新增。
- 主机 和 端口 分别输入
- 确认信息,然后点击发布。
要发布多个服务,你可以更新你的 ADC 配置文件以包含其他服务,或者使用多个配置文件并将它们同步到你的目标网关组,例如 default,如下所示:
adc sync -f adc-1.yaml -f adc-2.yaml
以下交互式演示介绍如何发布服务版本。你可以按照演示中的步骤了解如何在 API7 企业版中使用此功能。
验证 API
curl "http://127.0.0.1:9080/anything/publish"
你应该会看到以下输出:
{
"args": {},
"data": "",
"files": {},
"form": {},
"headers": {
"Accept": "*/*",
"Host": "localhost",
"User-Agent": "curl/7.88.1",
"X-Amzn-Trace-Id": "Root=1-664cc6d6-10fe9f740ab1629e19cf85a2",
"X-Forwarded-Host": "localhost"
},
"json": null,
"method": "GET",
"origin": "152.15.0.1, 116.212.249.196",
"url": "http://localhost/anything/publish"
}
相关阅读
- 核心概念
- 快速入门
- 最佳实践