DX Criteria (v202104)/企業のデジタル化とソフトウェア活用のためのガイドライン/✅クライテリア/SYSTEM-5-8

SYSTEM-5-8

クライテリア

APIがバージョン管理されておらず、破壊的な変更が利用者から検知できない。

タイプ

API駆動開発

観点

アンチパターン

FAQ

Q.APIのバージョン管理はどのように行うべきですか？

バージョンを上げる場合に利用者の利便性を考慮すると下位互換を持たせることがベストではあるが、利用者側のシステムが正常に稼働しなくなるバージョンアップに利用者側が対応できるような配慮が必要である。接続先URLに/v1/のようなバージョン番号を含む方法が一般的に使われている。