创建 API 网关

已完成

组织经常需要为合作伙伴提供数据访问权限。 必须控制和管理此访问权限。

在鞋业公司示例中,在 NorthWind Shoes 进货的零售商需要知道可订购的库存量。 客户也希望知道可到货的确切时间。

接下来,你将了解 Azure API 管理的工作原理,以及 API 网关的设置方法。

Azure API 管理

Azure API 管理服务托管在 Azure 云中,位于 API 和 Internet 之间。 API 管理实例充当 Azure API 网关。

发布 API 时,使用 Azure 门户来控制向使用者公开特定 API 的方式。 你可能希望开发人员可出于演示目的自由使用某些 API,并希望严格控制其对其他 API 的访问权限。

为何使用 API 管理?

对于开发人员,API 管理具有一系列优势。

  • API 文档。 通过 API 文档,调用客户端能够快速集成其解决方案。 借助 API 管理,可以通过 OpenAPI 等新式标准向调用客户端快速公开 API 的结构。 你可拥有多个版本的 API。 拥有多个版本时,可以逐步进行应用更新,因为所用应用不必立即使用新版本。
  • 速率限制访问权限。 如果 API 可能潜在地访问大量数据,最好将速率限制为客户端可请求数据的速率。 速率限制有助于保持每个客户端的最佳响应时间。 通过 API 管理,可以为全部客户端或单个特定客户端设置速率限制。
  • 运行状况监视。 远程客户端使用你的 API,因此很难识别潜在问题或错误。 而通过 API 管理,可以查看错误响应和日志文件,并按响应类型进行筛选。
  • JSON 等新式格式。 多年来,API 使用了从 XML 到 CSV 等许多不同的数据交换格式。 通过 API 管理,可以使用 JSON 等新式数据模型公开这些格式。
  • 与任何 API 的连接。 许多企业的 API 位于不同国家/地区并且使用不同格式。 通过 API 管理,可以将所有这些不同的 API 添加到单个新式接口。
  • 分析。 开发 API 时,查看 API 的调用频率以及进行调用的系统类型很有帮助。 通过 API 管理,可以在 Azure 门户中可视化数据。
  • 安全性。 处理系统数据时,安全性极其重要。 未经授权的安全漏洞可能导致公司花费金钱和时间重新编写代码,并可能造成名誉损失。 可与 Azure API 管理配合使用的安全工具包括 OAuth 2.0 用户授权,以及与 Microsoft Entra ID 的集成。
  • 定价层。 API 管理提供具有不同功能的层,用于请求吞吐量、SLA、网络隔离、升级灵活性等。 创建 Azure API 管理网关时,可以选择满足需求的层。

API 管理设置

若要设置 API 管理,请执行以下操作:

  1. 创建 API 管理网关。 用于网关的名称在 .azure-api.net 命名空间中必须是全局唯一的。
  2. 使用网关注册现有 Web API。 通过注册 API,使用者可在 <gateway>.azure-api.net 终结点使用 API。
  3. 通过网关调用现有 API。 使用者现在可以在终结点 URL 调用 API。