版本控制計畫
詳細了解我們的版本控制策略和不斷發展的結構描述。
發展結構描述
創新就是要不斷進步並保持領先地位。因此我們設計了 Rapid 3,讓您永遠不需要中斷您的步伐。
借助 Rapid 3 和我們不斷發展的結構描述,您將在功能準備就緒後就能立即使用。不再需要等待六個月後推出的新版本,也無需再花費數小時進行升級。
我們最新功能的版本不會影響整合,讓您可以繼續使用 Rapid 3 更久,進而節省您的時間和金錢。我們還會讓您知道即將推出的功能,以便您提前計劃。
版本控制策略
推出更大的功能或重大變更時,我們會在新版本中啟用這些功能,例如 Rapid 4。
我們的 Rapid API 技術團隊會維護一個 API 啟用版本,另一個則在開發中。當我們啟用已開發的最新版本時,它將變為啟用狀態,之前的版本將被標記為不建議使用。不建議使用的版本會繼續提供一年服務才停用,以便有足夠的時間移轉到最新最好的版本。在此期間,不建議使用的版本只會進行主要的安全修復程序。
術語
以下一些術語定義可幫助您了解我們的版本控制計畫:
啟用:Rapid 的目前啟用版本。您可隨時將非重大更改功能添加到啟用版本中,亦可決定是否要整合這些功能。
開發:我們正在開發且即將發布的 Rapid 版本。
不建議使用:當版本被標記為不建議使用時,表示該版本在一年後將無法再使用。這是升級到最新啟用版本的好時機。
退役:一旦某個版本退役,該版本將無法再透過 API 進行存取。
非重大變更:非重大變更是可以隨時新增到啟用版本中,並且不會破壞整合的功能。
非重大變更包括:
- 新增新端點。
- 新增新的可選查詢參數。
- 新增到請求正文的新可選請求欄位。
- 新增到請求的新可選標題。
- 強制請求參數變為可選。
- 新增到回應中的新欄位。
- 新增到回應中的新標題。
- 新增到請求列舉類型的新值。
- 新增到具有預設值的回應列舉類型的新值。
重大變更:重大變更是較大的功能更新,可能會破壞您現有的整合,我們只會對 Rapid 的新啟用版本發布重大變更,因此您不必擔心現有的整合。
重大變更包括:
- 移除現有端點。
- 新增新的必要查詢參數。
- 新增到請求內文的新必要請求欄位。
- 新增到請求的新必要標題。
- 可選的請求參數成為必要參數。
- 移除或重新命名查詢參數。
- 移除或重新命名回應欄位。
- 變更查詢參數的類型。
- 變更請求內文中請求欄位的類型。
- 向現有參數新增新的驗證要求。
- 移除或消除驗證或授權設定。
- 移除或重新命名列舉類型值。
- 新增到不含預設值的回應列舉類型的新值。