為何 API 版本策略很重要

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

API 版本管理入門

版本管理導入

Azure API Management

API 版本管理基礎

版本管理類比

  • 當破壞性變更會讓乘客困惑時使用

  • 新路線建置期間，乘客仍使用舊路線

  • 修訂如同在同一路線做維護微調

    • 修軌、加標示、讓行程更平順

  • 在 APIM 中：

    • 版本存在於一個「版本集」內
    • 修訂可讓你編輯、測試，並標記一個為「目前」
Azure API Management

版本標示方式

  • 支援 3 種版本標示策略：
    • 在 URL 路徑宣告版本
    • 在請求標頭指定版本
    • 在 URL 查詢字串指定版本
  • 版本策略需保持一致

URL 路徑版本

標頭版本

查詢字串版本

Azure API Management

版本與修訂的差異

版本 vs 修訂

Azure API Management

金絲雀發布

金絲雀發布

  • 結果：
    • 回饋佳 -> 將該修訂標記為「目前」
    • 回饋差 -> 回復到前一個修訂

  • 就像廚房試菜：先端新菜給少數桌次

  • 在 APIM 中：

    • 建立新修訂並先私下測試
    • 僅對少量受眾開放（試點產品或部分呼叫者）
    • 透過含修訂號的特殊 URL 鎖定特定修訂

  • 鐵路比喻：測試者走「維修側線」，不影響主線

Azure API Management

重點複習

  • 何時用版本、何時用修訂
  • 設定版本方案
  • 向前或回滾變更

API Management

Azure API Management

一起來練習吧！

Azure API Management

Preparing Video For Download...