跳轉到主要內容

版本管理

Flex Forward API 以長期穩定性為設計目標。變更會謹慎進行,以避免破壞現有整合。

目前版本

API 目前版本為 1.0.0。URL 中沒有版本前綴 — 所有端點直接存取(例如 POST /labels,而非 POST /v1/labels)。

向後相容性

Flex Forward 團隊致力於維護向後相容性。現有整合會在 API 演進的同時持續運作。

非破壞性變更

以下變更可能在未事先通知的情況下進行。您的整合應妥善處理:
  • 在請求本文中新增可選欄位
  • 在回應本文中新增欄位
  • 新增 API 端點
  • 在回應欄位中新增列舉值
  • 為邊界情況新增 HTTP 狀態碼
  • 改善錯誤訊息的清晰度
對 API 回應中的未預期欄位,請忽略而非視為錯誤。對未知的列舉值也請妥善處理 — 例如,將無法識別的追蹤 tag 視為 Unknown。這能確保您的整合對非破壞性新增具有韌性。

破壞性變更

以下變更被視為破壞性且將事先通知:
  • 移除或重新命名現有欄位
  • 變更現有欄位的資料類型
  • 移除 API 端點
  • 變更身份驗證機制
  • 變更現有狀態碼的含義
破壞性變更將透過變更記錄以及對受影響的 API 使用者的直接通知提前公布。非破壞性改善可能在維持現有整合向後相容性的前提下,無需變更 URL 版本即可發布。

整合建議

  • 寬容地解析回應本文 — 忽略未知欄位
  • 不要使用會拒絕新欄位的嚴格綱要來驗證回應
  • 關注 變更記錄 以取得 API 變更的更新
  • 更新整合時在開發環境中進行測試