APIバージョニング戦略が重要な理由

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

APIバージョニングの概要

バージョニング入門

Azure API Management

APIバージョニングの基礎

バージョニングの例え

  • 破壊的変更が混乱を招く場合に使用

  • 新線の建設中も乗客は旧線を利用し続ける

  • リビジョンは同じ路線のメンテナンス作業に相当

    • 線路修繕、標識追加、乗り心地改善

  • APIMでは:

    • バージョンはバージョンセット内に存在
    • リビジョンで編集・テストし、1つを現行としてマーク
Azure API Management

バージョン指定方式

  • バージョン指定方式は3種類サポート:
    • URLパスでバージョンを宣言
    • リクエストヘッダーでバージョンを指定
    • URLクエリ文字列でバージョンを指定
  • バージョニング戦略は統一する必要あり

URLパスのバージョニング

ヘッダーのバージョニング

クエリ文字列のバージョニング

Azure API Management

バージョンとリビジョン

バージョンとリビジョンの比較

Azure API Management

カナリアリリース

カナリアリリース

  • 結果:
    • フィードバックが良好 -> リビジョンを現行としてマーク
    • 不良 -> 前のリビジョンにロールバック

  • 例：新メニューを一部のテーブルで先行提供

  • APIMでの手順:

    • 新しいリビジョンを作成し、非公開でテスト
    • 限定的なオーディエンスに公開（パイロット製品または一部の呼び出し元）
    • リビジョン番号付きの特別なURLで特定のリビジョンをターゲット指定

  • 鉄道の比喩：テスターは本線に影響を与えずに「保守専用線」を利用

Azure API Management

重要な概念のまとめ

  • バージョンとリビジョンの使い分け
  • バージョンスキームの設定
  • 変更の前後へのロールバック

API Management

Azure API Management

では、練習しましょう！

Azure API Management

Preparing Video For Download...