你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
API 管理和卓越运营
了解如何使用 API 管理安全而大规模地将 API 发布给外部人员、合作伙伴和员工开发人员。 此网络服务是适用于所有环境中 API 的混合多云管理平台。
组件包括:
有关详细信息,请参阅 API 管理介绍。
要了解 API 管理如何支持卓越运营,请参阅以下主题:
清单
配置 API 管理时是否考虑了卓越运营?
- 保护 API 管理与后端之间的通信。
- 当向第三方公开 API 时,请确保每一方都有自己的凭据。
- 当向第三方公开 API 时,请确保设置了配额和速率限制。
- 了解 Microsoft REST API 设计和体系结构指南。
- 可对 API 进行版本控制,以在添加其他功能时保持向后兼容性。
- 使用 API 管理版本控制和修订功能实现 API 版本控制。
- 了解 API 管理中的 API 导入限制。
- 了解事件日志记录功能。
- 跟踪 Azure API 管理中的调用,以帮助进行调试和测试。
- 使用 Azure Monitor 配置日志记录,以获得 API 管理服务。
- 选择适当的模式以访问专用站点连接。
- 基于 API 管理公共 IP 地址评估防火墙规则和 IP 允许列表。
配置建议
在配置 API 管理服务时,请考虑以下建议以提高卓越运营能力:
建议 | 说明 |
---|---|
当向第三方公开 API 时,请确保设置了配额和速率限制。 | 保护后端服务,并减少在 API 管理缩放单元上发生的负载。 可以在全局、产品、API 和操作级别应用速率限制策略,以提供应用于 API 使用者的速率限制自定义。 |
了解 Microsoft REST API 设计和体系结构指南。 | 使用 REST API 时,请遵循标准和最佳做法。 遵循最佳做法可跨平台和实施方案实现最高兼容性。 查看 REST API 准则和 API 设计指南。 |
了解 API 管理中的 API 导入限制。 | 全力确保 API 导入过程顺利运行,包括无需自定义。 某些方案强制要求对导入源进行修改的限制。 适用于 REST 和 SOAP 服务。 参考策略限制以了解当前 API 导入限制。 |
了解事件日志记录功能。 | 支持将事件日志记录到 Azure 事件中心,以执行近乎实时的分析。 此功能与外部日志记录、安全信息和事件管理 (SIEM) 解决方案集成,或以近乎实时的方式分析 API 使用情况。 |
跟踪 Azure API 管理中的调用,以帮助进行调试和测试。 | 必须对用于发出请求的订阅启用跟踪。 使用 Ocp-Apim-Trace 标头值按请求启用跟踪。 API 跟踪也内置于管理门户中,并且默认情况下在从门户测试 API 时启用。 |
使用 Azure Monitor 配置日志记录,以获得 API 管理服务。 | 可以将日志发送到 Log Analytics 工作区,以实现复杂的查询和分析。 指标可以引入,以进行更长期的分析。 然后,使用 Azure Monitor 显示所有数据。 可以集成 Application Insights 以实现应用程序性能管理。 |
选择适当的模式以访问专用站点连接。 | 支持内部和外部模式下的虚拟网络集成。 |
基于 API 管理公共 IP 地址评估防火墙规则和 IP 允许列表。 | 使用适用于 API 管理的基本、开发人员、标准和高级版计划,可以在服务的生存期内使用固定的公共 IP 地址。 |