版本控制計畫
深入了解我們針對預訂分析 API 持續發展的結構描述和版本控制策略。
發展結構描述
在步調快速的科技世界中,保持領先地位至關重要。這就是為什麼我們的分析 API 旨在滿足您的需求。隨著我們的結構描述持續發展,新功能一開發完成您就會收到相關消息。告別漫長的新版本等待或繁瑣的升級過程。
我們的最新功能旨在流暢整合,確保您繼續使用目前的版本而不會中斷。這項方法可以節省您的時間和金錢。我們將隨時向您告知即將推出的功能,以便您有效地規劃。
版本控制策略
對於可能影響現有整合的重大更新或更改,我們引入了新版本,例如分析 API v2。
在開發下個版本的同時,我們的 API 團隊也會管理啟用版本。新版本一經推出,就會成為啟用版本,而先前版本將進入停用階段。已停用版本仍可使用一年,提供充裕的版本過渡時間。在此期間,將僅為已停用版本提供關鍵安全性更新。
術語
這些定義有助於更輕鬆地理解我們的版本控制計畫:
啟用:分析 API 的當前啟用版本,其中新增了不間斷的變更和功能。您可以根據選擇靈活地整合這些功能。
開發:即將推出的開發中 API 版本。
停用:標記為停用的版本表示將在一年後逐步停用。這段期間是升級到最新啟用版本的最佳時機。
已淘汰:無法再透過 API 存取的已淘汰版本。
非重大變更:這些更新可以在不影響您現有設定的情況下進行整合。這些更新包括新端點、可選查詢參數和回應欄位等項目。
非重大變更包括:
- 新增新端點。
- 新增新的可選查詢參數。
- 新增到請求正文的新可選請求欄位。
- 新增到請求的新可選標題。
- 強制請求參數變為可選。
- 新增到回應中的新欄位。
- 新增到回應中的新標題。
- 新增到請求列舉類型的新值。
- 新增到具有預設值的回應列舉類型的新值。
重大變更:可能需要更動整合的重大更新。其中包括移除端點、引入新的必要參數,以及更改身分驗證設定等。僅在新的 API 啟用版本中才會引入重大變更。
重大變更包括:
- 移除現有端點。
- 新增新的必要查詢參數。
- 新增到請求內文的新必要請求欄位。
- 新增到請求的新必要標題。
- 可選的請求參數成為必要參數。
- 移除或重新命名查詢參數。
- 移除或重新命名回應欄位。
- 變更查詢參數的類型。
- 變更請求內文中請求欄位的類型。
- 向現有參數新增新的驗證要求。
- 移除或消除驗證或授權設定。
- 移除或重新命名列舉類型值。
- 新增到不含預設值的回應列舉類型的新值。