Skip to content
Latchkey

API Versioning - CI/CD用語集の定義

API versioning とは、APIが変更されてもクライアントが動作し続けるようにAPIにラベルを付ける実践で、URLセグメント (/v2/)、ヘッダー (Accept: application/vnd.github+json)、または日付ベースのバージョンを使います。

なぜ重要か

CIスクリプトでAPIバージョンを固定すること (たとえばGitHubの日付入りX-GitHub-Api-Versionヘッダー) は、プロバイダが後方互換性のない変更を出荷した日にpipelineが壊れるのを防ぎます。

関連ガイド