发现 API 管理服务
API 管理提供了核心功能,通过开发人员参与、商业洞察力、分析、安全和保护确保成功的 API 程序。 每个 API 包括一个或多个操作,并可以将每个 API 添加到一个或多个产品。 要使用的 API,开发人员需要订阅包含该 API 的产品,它们可以调用该 API 的操作,根据任何可能生效的使用情况策略。
API 管理组件
Azure API 管理由 API 网关、管理平面和开发人员门户组成。 这些组件是 Azure 托管的,默认情况下是完全托管的。 API 管理在各种层中都有提供,这些层的容量和功能都不同。
API 网关 是具有以下功能的终结点:
- 接受 API 调用,并将调用路由到相应的后端
- 验证与请求一起提供 API 密钥和其他凭据
- 强制使用配额和速率限制
- 转换策略语句中指定的请求和响应
- 缓存响应以改善响应延迟并最大程度地减少后端服务负载
- 发出用于监视、报告和故障排除的日志、指标和跟踪
管理平面是一个管理界面,可以在其中设置 API 程序。 使用它可执行以下操作:
- 预配和配置 API 管理服务设置
- 定义或导入 API 架构
- 将 API 打包到产品中
- 设置策略,如 API 的配额或转换
- 从分析中获得见解
- 管理用户
开发人员门户是一个自动生成的、可完全自定义的网站,其中包含 API 的文档。 使用开发人员门户,开发人员可以:
- 阅读 API 文档
- 通过交互式控制台调用 API
- 创建帐户并可以订阅以获取 API 密钥
- 访问他们自己的使用情况分析
- 下载 API 定义
- 管理 API 密钥
产品
产品是如何将 API 提供给开发人员。 API 管理中的产品有一个或多个 API,并且配置为包含一个标题、说明和使用条款。 产品可以公开或受保护。 必须先订阅受保护的产品,才能使用它们,但公开的产品无需订阅即可使用。 在产品级别配置订阅批准,也可由管理员批准或被自动批准。
组
组用于管理产品对开发人员的可见性。 API 管理具有下列不可变的系统组:
- 管理员 - 管理 API 管理服务实例、创建 API、操作,以及开发人员所使用的产品。 Azure 订阅管理员是此组的成员。
- 开发人员 - 经过身份验证的开发人员门户用户,使用你的 API 构建应用程序。 开发人员有权访问开发人员门户,并构建调用 API 操作的应用程序。
- 来宾 - 未经身份验证的开发人员门户用户。 可以授予他们某些只读访问权限,如能够查看 API,但不能调用它们。
除了这些系统组以外,管理员还可以在关联的 Microsoft Entra 租户中创建自定义组或使用外部组。
开发人员
开发人员表示 API 管理服务实例中的用户帐户。 可以创建或邀请开发人员加入管理员,或它们可以从开发人员门户注册。 每个开发人员是一个或多个组的成员,并且可以订阅授予这些组的可见性的产品。
策略
策略是一组语句,在请求或 API 的响应时按顺序执行。 流行的语句包含 XML 格式转换为 JSON 和调用速率限制,以限制从开发人员传入的呼叫数,还有许多其他策略可用。
在任何 API 管理策略中,策略表达式可以用作属性值或文本值,除非该策略另外指定。 某些策略(如控制流和设置变量策略)基于策略表达式。
策略可应用于不同的范围,具体取决于你的需求:是全局(所有 API)、某个产品、某个特定 API 还是某个 API 操作。