为何 API 版本管理策略很重要

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

API 版本管理简介

版本管理简介

Azure API Management

API 版本管理基础

版本管理类比

  • 当破坏性变更会让乘客困惑时使用

  • 新线路建设中，乘客继续使用旧线

  • 修订如同同一线路的维护微调

    • 修轨、加标识、提升平顺性

  • 在 APIM 中：

    • 版本存在于版本集中
    • 修订用于编辑、测试，并标记一个为当前
Azure API Management

版本标识方式

  • 支持三种版本标识策略：
    • 在 URL 路径声明版本
    • 在请求头指定版本
    • 在 URL 查询串指定版本
  • 版本策略需保持一致

URL 路径版本

请求头版本

查询串版本

Azure API Management

版本 vs 修订

版本 vs 修订

Azure API Management

金丝雀发布

金丝雀发布

  • 结果：
    • 反馈良好 -> 将修订标记为当前
    • 不佳 -> 回滚到上一修订

  • 像厨房试菜：先只给少数桌试新菜

  • 在 APIM 中：

    • 创建新修订并私测
    • 仅向小范围用户开放（试点产品或部分调用方）
    • 通过带修订号的特殊 URL 定向到特定修订

  • 铁路类比：测试者走"维护线"，不影响主线

Azure API Management

关键概念回顾

  • 何时用版本 vs 修订
  • 配置版本方案
  • 前滚与回滚变更

API 管理

Azure API Management

让我们来练习！

Azure API Management

Preparing Video For Download...