APIバージョニング とは
APIバージョン管理
APIバージョニング
APIバージョニングは、既存のクライアントとの後方互換性を維持しながらAPIの変更を管理する実践です。
バージョニング戦略
| 戦略 | 例 | 説明 | |------|-----|------| | URLパス | /api/v1/users | URLパス内のバージョン | | クエリパラメータ | /api/users?version=1 | パラメータ内のバージョン | | ヘッダー | X-API-Version: 1 | ヘッダー内のバージョン | | Content Type | Accept: application/vnd.api.v1+json | メディアタイプバージョン |
セマンティックバージョニング
- メジャー (v1→v2) — 破壊的変更
- マイナー (v1.1→v1.2) — 新機能、後方互換性あり
- パッチ (v1.1.0→v1.1.1) — バグ修正
ベストプラクティス
- すべての変更を文書化(changelog)
- 最低2バージョンをサポート
- 非推奨を事前に通知
- sunsetヘッダーを使用
- 移行ツールを提供
新バージョンが必要な場合
- フィールドやエンドポイントの削除
- レスポンス形式の変更
- パラメータセマンティクスの変更
- 認証の変更