API Versioning

API バージョン管理はインターフェース変更を管理し、新バージョンが旧クライアントを破壊しないようにし、URL パス/ヘッダ/クエリパラメータ版が一般的である。

目的

API の進化を管理し、後方互換性と平滑移行を保証する。

メカニズム

URL パス：/v1/users（明示的で単純）。ヘッダ：Accept: application/vnd.api+json;version=1（RESTful）。クエリ：?version=1。意味版：major は互換破壊、minor は新機能、patch は修復。旧版は移行期を設けて廃止。

ユースケース

API の管理
バックワード互換性の維持
バージョンの進化

関連用語

API ゲートウェイはマイクロサービスの統一入口であり、ルーティング、認証、流量制限、キャッシュ、プロトコル変換等の横断関心事を処理する。

References