Azure API 中心 - 关键概念

本文介绍 Azure API 中心的关键概念。 Azure API 中心支持在一个集中位置跟踪 API，以便进行发现、重用和治理。

数据模型

下图显示了 Azure API 中心的主要实体及其相互关联方式。 有关这些实体和相关概念的详细信息，请参阅以下部分。

API

Azure API 中心中的顶级逻辑实体，其中 API 表示要跟踪的任何真实 API。API 中心可以包括任何类型的 API，包括 REST、GraphQL、gRPC、SOAP、WebSocket 和 Webhook。

API 可由任何 API 管理解决方案（例如 Azure API 管理或来自其他提供商的解决方案）管理，也可以不对其进行管理。

Azure API 中心中的 API 清单旨在由 API 项目经理或 IT 管理员创建和管理。

API 版本

API 版本控制是管理对 API 的更改并确保在不干扰客户端的情况下进行这些更改的做法。 API 可以跨生命周期阶段具有多个版本，每个版本都与特定的 API 更改保持一致。 某些版本可能会引入重大更改或中断性变更，而另一些版本则添加次要改进。 API 版本可以处于任何生命周期阶段 – 从设计到预览、生产或弃用。

API 定义

最好由至少一个定义（例如 REST API 的 OpenAPI 定义）定义每个 API 版本。 Azure API 中心允许使用格式化为文本的任何 API 定义文件（YAML、JSON、Markdown 等）。 可以上传 OpenAPI、gRPC、GraphQL、AsyncAPI、WSDL 和 WADL 定义等。

环境

环境表示可以部署 API 运行时的位置，例如，Azure API 管理服务、Apigee API 管理服务或计算服务（例如 Kubernetes 群集、Web 应用或 Azure 函数）。 每个环境都与开发、测试、暂存或生产等一个生命周期阶段保持一致。 环境还可以包含有关开发人员门户或管理界面的信息。

部署

部署是用户可以访问 API 的位置（地址）。 API 可以有多个部署，例如不同的过渡环境或区域。 例如，API 可以在内部过渡环境中有一个部署，在生产环境中有另一个部署。 每个部署都与特定的 API 定义相关联。

元数据

在 Azure API 中心内，通过设置元数据属性的值来组织 API、部署和其他实体，这可用于搜索和筛选以及强制实施治理标准。 API 中心提供多个常见的内置元数据属性，例如“API 类型”和“生命周期阶段”。 API 中心所有者可以通过在元数据架构中定义自定义元数据来扩充内置元数据，以组织其 API、部署和环境。 例如，创建 API 审批者属性来标识负责批准要使用的 API 的个人。

Azure API 中心支持数组、布尔、数字、对象、预定义选项和字符串类型的自定义元数据。

Azure API 中心的元数据架构与 JSON 和 YAML 架构规范兼容，从而允许在开发人员工具和自动化管道中进行架构验证。

相关内容

• 什么是 Azure API 中心？
• API 治理的元数据