API Versioning
API 版本管理
API 版本管理是一套命名、修改、支援和淘汰 API 契約的計畫，目的是避免破壞用戶端。沒有任何一種 URL 或標頭寫法適用所有 API。
另一個例子
薪資 API 發布 OpenAPI 契約 `2026-07`，同時讓 `/v1` 用戶端繼續運作。新增選填欄位不會破壞相容性；但把 `netPay` 從整數分改成小數，就需要新的主要版本契約、遷移範例、棄用標頭、使用資料和退役日期。
主要部分
- 01契約識別碼
- 02相容規則
- 03棄用與遷移
什麼時候用
先定義相容規則、變更類型、版本探索方式、支援期間和棄用政策，再選擇路徑、媒體格式或標頭寫法。
什麼時候不要用
不要每次發布都建立新的 API 版本。沒有使用資料和舊版退役機制時，也不要承諾永久相容。
程式裡的名稱
explicit compatibility policy + versioned OpenAPI document + deprecation and sunset lifecycle 上線前要檢查
檢查介面約定、任何情況都不能破壞的規則、授權與輸入限制。測試重試、重複執行只生效一次、逾時與部分失敗。驗證資料完整性、相容性、監控、復原與回復上一版。
預期成果：為這套系統設計或檢查 API 版本管理 (API Versioning)，並讓資料保持正確、安全且容易維護。 使用者情境：薪資 API 發布 OpenAPI 契約 `2026-07`，同時讓 `/v1` 用戶端繼續運作。新增選填欄位不會破壞相容性；但把 `netPay` 從整數分改成小數，就需要新的主要版本契約、遷移範例、棄用標頭、使用資料和退役日期。 技術概念或控制措施：API 版本管理 (API Versioning)。 適用理由：先定義相容規則、變更類型、版本探索方式、支援期間和棄用政策，再選擇路徑、媒體格式或標頭寫法。 不應使用的情況：不要每次發布都建立新的 API 版本。沒有使用資料和舊版退役機制時，也不要承諾永久相容。 工程要求：定義輸入、輸出、介面約定，以及任何情況都不能破壞的規則。說明授權與輸入檢查範圍。定義失敗、逾時、重試和重複執行只生效一次的規則。也要定義資料搬移與相容限制。 營運要求：加入監控訊號與隱藏敏感資料的記錄。設定容量上限並寫好操作手冊。測試復原與回復上一版的流程。 驗收條件：介面約定與失敗路徑測試通過。重試或部分失敗時，資料與授權規則仍正確。效能上限、監控、復原與回復上一版的方法都已驗證。 證據與限制（證據邊界）：沒有一份官方標準能管到全部內容。不同團隊、平台或框架的用法可能不同。 待確認：程式執行環境、資料位置、流量形態、資料一致需求和安全邊界。也要確認相容期間、服務目標（SLO）與回復上一版的限制。
檢查這份需求
請 AI 程式助手檢查目前如何使用 API 版本管理 (API Versioning)。 定義：API 版本管理是一套命名、修改、支援和淘汰 API 契約的計畫，目的是避免破壞用戶端。沒有任何一種 URL 或標頭寫法適用所有 API。 正式環境檢查：檢查介面約定、任何情況都不能破壞的規則、授權與輸入限制。測試重試、重複執行只生效一次、逾時與部分失敗。驗證資料完整性、相容性、監控、復原與回復上一版。 修改程式前，先列出看到的證據、缺口、嚴重程度，以及最小且安全的修正。