版本概览

本页面适用于 ApigeeApigee Hybrid

本主题介绍了在 API Hub 中创建和管理版本需要了解的信息。

什么是版本?

API Hub 中的每个 API 资源都至少有一个与之关联的版本。您可以将版本视为 API 在某个时间点的状态。从根本上说,版本可帮助您根据底层的操作、部署、规范和其他属性集对 API 进行分组和整理,如图 1 所示。

API 实体关系。

图 1. 每个版本都可以具有操作、部署和其他属性。

在 API Hub 中,版本表示 API 的逻辑分组。通常(但不一定)此分组围绕 API 可以执行的操作进行。例如,假设您有一个宠物商店 API,并且此 API 的第一个版本可让您执行基本任务,例如添加宠物、查找宠物以及从商店中删除宠物。这些是操作示例。

最好是让一个版本包含一组一起部署的 API 操作。例如,宠物商店 API 可能有一个包含添加、查找和删除操作的版本,这些操作均部署到相同的环境。

考虑版本的另一种好思路是它代表 API 提供方对 API 的了解。版本是构建 API 的人员在 API 中加入并希望与其一起部署的特性和功能的集合。

创建版本

假设在 OpenAPI 规范中会捕获您要添加到 API Hub 的 API 的详细信息。如果是这样,您可以将规范添加到 API 版本。执行此操作时,API Hub 会解析规范并从中拉取信息(例如 API 包含的操作),并将这些信息与版本一起存储。如果您没有 OpenAPI 规范,您仍然可以创建版本,但必须使用相关的描述性信息手动填充。API Hub 支持通过 Apigee API 代理自动注册来解析 API 详细信息的另一种情况。

您可以向同一版本上传多个 API 规范文件。

何时创建新版本?

如果向 API 添加了新操作,则可能需要创建新版本,也可能不需要。

假设 API 提供方向某个 API 添加了新操作,并打算将其部署到当前与该版本关联的所有部署。在这种情况下,提供方可以选择不创建该 API 的新版本。另一方面,如果提供方进行了向后不兼容的更改(重大更改),并选择将其与新部署相关联,则您可能需要创建新版本。

您可以看到,API Hub 可让您灵活地定义和组织 API 版本,从而最好地满足您的组织的需求和特定 API 提供方的需求。

系统属性

默认情况下,版本包含以下系统属性。您可以在设置中修改与这些属性关联的值。如需了解详情,请参阅管理属性

属性 说明
Lifecycle 生命周期是指 API 应逐步完成的一组有序阶段(从概念到服务终止)。由于 API 的每个版本通常都会单独经历其生命周期,因此我们不会直接设置 API 的生命周期阶段,而是允许每个 API 版本具有指定的生命周期阶段。
合规性 通过设置,您可以定义值来表示您的团队或组织相关的合规性详细信息。如需了解详情,请参阅管理属性
认证 通过设置,您可以定义值来表示您的团队或组织相关的认证详细信息。如需了解详情,请参阅管理属性
文档 版本附加到的 API 文档的链接。

用户定义的属性

根据您的团队或组织需求,您可以为版本定义自定义属性(名称/值对)。请参阅管理属性