GitHub更新API版本控制的命名方法,以日期來命名版本號,像是在2025年12月25日發布的新版本,該版本就會被命名成2025-12-25,這項規則僅適用於具有重大變更的版本。這項基於日期的版本控制方法,讓官方可以不斷發展API,但同時有提供順暢的搬遷路徑和充足的時間,供用戶進行整合。

目前GitHub API有數百萬使用者,包含開發者自建,以及來自GitHub Marketplace第三方應用程式的整合。API隨著時間推移會出現變化,勢必加入更新的產品功能、修復錯誤或是改善開發人員體驗,但另一方面,在API更改時,官方無法期待API使用者會不斷地更新整合。

API變更分成兩種,一種是不會對現有整合產生負面影響的情況,稱為非破壞性變更,另一種破壞性變更,則會出現刪除回應欄位、參數變更或是完全刪除端點等情況。GitHub在10年前釋出API V3,這個版本雖然運作良好,但是未提供適當的工具和流程,無法在進行重大更新時支援現有用戶順暢的搬遷。

GitHub建議所有整合都要使用最新的API版本,官方提到,他們通常並不會頻繁地淘汰舊版本,或是強制用戶升級,當有新的REST API版本發布時,也會至少支援舊版本2年。當新版本升級,之前的版本同樣可用,用戶不會被強迫升級,並且可以使用X-GitHub-Api-Version標頭要求指定使用的版本,來選擇所要使用的版本。

正在使用GitHub REST API的開發者,目前不需要採取任何行動,GitHub API的現有狀態,也就是用戶當前使用的版本為2022-11-28,但官方鼓勵用戶更新整合,並且主動發送X-GitHub-Api-Version: 2022-11-28標頭。不過,GitHub在接下來幾個月內,就會發布另一個包含重大更新的版本,要搬遷到該版本,就會需要使用X-GitHub-Api-Version標頭並且指向新版本。

目前這個以日期為基礎的API版本號控制方法僅適用於REST API,在GraphQL API和webhooks則未提供。

熱門新聞

Advertisement