发布服务版本
要对已部署的 API 进行版本控制,应通过 API7 网关将服务版本发布到不同的网关组,而不是直接在网关组中修改配置。
通常,API 版本会先发布到测试和预发布环境,再发布到生产环境。API7 网关通过网关组管理这些环境的隔离,API 归属于单个已发布服务,共享同一个上游。
本教程介绍如何在 API7 网关中将 httpbin 服务发布到网关组。你将学习如何:
- 手动或通过 OpenAPI 规范文件创建服务。
- 通过配置上游节点或使用服务发现机制发布服务。
前提条件
- 安装 API7 企业版。
- 在网关组中至少有一个网关实例。
新增带有路由的服务模板
手动新增
- 控制台
- ADC
- 从侧边栏选择服务中心,然后点击新增服务。
- 选择手动新增。
- 在对话框中,执行以下操作:
- 在服务类型字段中选择
HTTP(七层代理)。 - 在名称字段中输入
httpbin。 - 点击新增。
- 在服务内点击新增路由。
- 在新增路由对话框中,执行以下操作:
- 在名称字段中输入
get-ip。 - 在路径字段中输入
/ip。 - 在方法字段中选择
GET。 - 点击新增。
创建 ADC 配置文件,包含服务、上游和路由配置:
adc.yaml
services:
- name: httpbin
upstream:
name: httpbin upstream
scheme: http
nodes:
- host: httpbin.org
port: 80
weight: 100
routes:
- uris:
- /ip
name: get-ip
methods:
- GET
导入 OpenAPI 规范
控制台和 ADC 都支持导入 OpenAPI v3.0 规范。
按以下示例,在 YAML/JSON 文件中定义 API:
OpenAPI.yaml
openapi: 3.0.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: get-ip
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 文件。
- 点击下一步。
- 确认以下信息:
- 名称:OpenAPI 规范中的
title字段。 - 标签:OpenAPI 规范中的
tags字段。 - 描述:OpenAPI 规范中的
description字段。 - 路由:OpenAPI 规范中的
Paths字段。 - 点击新增。
使用 ADC 将 OpenAPI 规范转换为 ADC 配置文件:
adc convert openapi -f openapi.yaml -o adc.yaml
将单个服务发布到网关组
- 控制台
- ADC
- 从侧边栏选择服务中心,然后选择
httpbin。 - 点击发布。
- 在对话框中,执行以下操作:
- 在网关组字段中选择目标网关组,例如
default。 - 在新版本字段中输入
1.0.0。 - 点击发布。
信息
首次发布服务时,需要配置必要的服务运行时配置并启用服务,才能激活 API。后续发布时,服务状态和运行时配置将从上一版本继承。
将上一步创建的配置文件同步到目标网关组,例如 default:
adc sync -f adc.yaml --gateway-group default
配置服务运行时配置
- 发布后,你将被重定向到网关组中的已发布服务。
- 从侧边栏选择上游。
- 点击新增节点。
- 在新增节点对话框中,执行以下操作:
- 在主机字段中输入
httpbin.org。 - 在端口字段中输入
80。 - 在权重字段中输入
100。 - 点击新增。
- 点击已发布服务页头的启用并确认。
验证 API
curl "http://127.0.0.1:9080/ip"
你应该会看到以下响应:
{
"origin": "127.0.0.1"
}
相关阅读
- 核心概念
- 快速入门
- 最佳实践