你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

什么是 Azure API 中心(预览版)?

API 中心支持在集中位置跟踪所有 API,以便进行发现、重用和治理。 使用 API 中心开发和维护组织 API 的结构化有序清单(无论其类型、生命周期阶段或部署位置如何),以及相关信息,例如版本详细信息、API 定义文件和通用元数据。

借助 API 中心,整个组织的利益干系人(包括 API 计划经理、IT 管理员、应用程序开发人员和 API 开发人员)可以发现、重用和治理 API。

重要

  • API 中心处于预览状态。 此预览版的提供不含服务级别协议,我们会不时在该预览版中进行中断性变更。 更改 API 中心预览版数据模型可能会导致数据丢失。 有关详细信息,请参阅 Microsoft Azure 预览版补充使用条款
  • 在预览期间,可在此 GitHub 存储库中请求功能、报告 bug 或提供其他反馈。

注意

API 中心是组织编录和管理其 API 清单的解决方案。 Azure 还提供 API 管理服务,这是一种用于通过 API 网关管理、保护和发布组织的 API 后端的解决方案。 详细了解差异。

好处

  • 创建和维护组织清单 - 组织可生成一个在其组织中可用的完整的 API 清单。 促进通信,让 API 计划经理和开发人员协作以提高 API 重用、质量、安全性、合规性和开发人员工作效率。

  • 管理组织的 API - 通过更全面地了解组织内生成的和使用 API,API 项目经理和 IT 管理员可以管理此清单, 通过定义自定义元数据分析 API 定义,以强制实施 API 样式准则的符合性,从而确保其符合组织标准。

  • 简单的 API 发现 - 组织希望促进 API 重用,以最大限度地提高开发人员的工作效率,并确保开发人员使用正确的 API。 API 中心可帮助计划经理和开发人员使用内置和自定义元数据属性发现 API 清单和筛选器。 ​

  • 加速 API 使用 - 在使用 API 时最大程度地提高开发人员工作效率,并确保它们以与组织标准一致的安全方式使用。

关键功能

在预览状态下,可在 Azure 门户中创建并使用 API 中心来用于以下各项:

  • API 清单管理 - 注册组织的所有 API 以包含在集中式清单中。

  • 实际 API 表示形式 - 添加有关每个 API 的真实信息,包括版本和定义(如 OpenAPI 定义)。 列出 API 部署并将其与运行时环境相关联,例如表示 Azure API 管理或其他 API 管理解决方案。

  • API 治理 - 使用内置和自定义元数据属性来组织和筛选 API 和相关资源,以帮助 API 使用者实现 API 治理和发现。 设置 Lint 分析和分析以强制实施 API 定义质量。

  • API 发现和重用 - 使开发人员和 API 项目经理能够通过 Azure 门户、API 中心门户和开发人员工具(包括与 GitHub Copilot 集成的 Visual Studio Code 扩展)发现 API。

有关可在 API 中心管理和功能中的实体的详细信息,请参阅关键概念

可用区域

API 中心当前在以下 Azure 区域中可用:

  • 澳大利亚东部
  • 印度中部
  • 美国东部
  • 英国南部
  • 西欧

API 中心和 API 生态系统

API 中心可在组织的 API 生态系统中扮演关键角色。 考虑假设的 Contoso 组织,它采用了 API 优先的策略,强调 API 在其软件开发和集成中的重要性。

Contoso 的 API 开发人员、应用开发人员、API 计划经理和 API 管理员通过 Azure API 中心进行协作,以开发和使用组织的 API 清单。 请参阅下图和说明。

Diagram showing API Center in an example API ecosystem.

Contoso 的 API 生态系统包括以下内容:

  • API 开发 - Contoso 的开发人员定期生成 ASP.NET Web API。 他们还使用 HTTP 触发器创建 Azure Functions。

  • API 部署环境 - Contoso 将其一部分 API 部署到 Azure 应用服务。 另一部分 API 部署到 Azure 函数应用。

  • API 管理 - Contoso 使用 Azure API 管理来管理、发布和保护其 API。 他们使用单独的实例进行开发、测试和生产,每个实例都有不同的名称:APIM-DEV、APIM-TEST 和 APIM-PROD。

  • API 中心 - Contoso 已采用 Azure API 中心作为其集中式 API 发现、治理和使用中心。 API 中心充当结构化有序的 API 中心,提供有关所有组织 API 的综合信息,维护包括版本和相关部署在内的相关信息。

常见问题解答

问:Azure API 管理和 Azure API 中心之间的区别是什么?

答:Azure API 管理是一项完全托管的 Azure 服务,可帮助组织安全地向外部和内部客户公开其 API。 它提供了一组工具和服务,用于创建、发布和管理 API,以及强制实施安全性、缩放并监视 API 使用情况。

另一方面,Azure API 中心帮助组织创建组织中可用的 API 目录。 Azure API 中心提供有关 API 的基本信息,例如其名称、说明和版本,但可使用自定义元数据将其他信息添加到这些 API。 Azure API 中心帮助不同的利益干系人(如 API 管理员或 API 开发人员)发现和重用组织中的现有 API。

虽然这两种服务都提供用于治理 API 的工具,但是它们的用途不同。 Azure API 管理是一个用于创建、发布和管理 API 的平台,而 API 中心提供了一个集中位置,用于发现和重用组织中的现有 API。

问:如何将 API 中心与 API 管理解决方案配合使用?

答:API 中心是一项独立的 Azure 服务,与其他提供商提供的 Azure API 管理和 API 管理服务相得益彰。 API 中心为组织中的所有 API 提供统一的 API 库存,包括未在 API 网关中运行的 API(例如仍处于设计状态的 API),以及使用不同 API 管理解决方案管理的 API。

对于使用 API 管理解决方案管理的 API,API 中心可存储元数据,例如运行时环境和部署详细信息。

问:我的数据是否已在 API 中心加密?

答:是,API 中心中的所有数据都是静态加密的。

后续步骤