棄用API須要瞭解什麼

API領域中常常出現的一個話題是公司決定棄用API的版本,或者徹底關閉對API的支持。 做爲向公衆提供API的團隊,重要的是要制定一個計劃,以計劃如何管理不一樣版本的API的棄用和報廢。那麼團隊如何最好地棄用API?首先,讓咱們瞭解API棄用的緣由,而後重點介紹一些建議的作法以有效棄用。api

什麼時候不推薦使用API

棄用和禁用API的決定是一個困難的決定。沒有正確的方法,但確定有錯誤的方法。記住,若是不正確地棄用API,可能會損害公司的品牌聲譽和信任度。 進行API棄用的緣由有不少。棄用API版本多是由於:
API不安全
API有太多錯誤
該API不支持重要的用例
API效率低下
在當今快速發展的技術領域中,API不斷添加新的和更新改進,舊版本也不斷新增。若是能夠迅速提供一種具備適當資源的良好和穩定的替代方案,則這種棄用形式不會對消費者的應用產生太大影響。 還有一種更永久的否決形式,徹底刪除或禁用API。這裏,API已徹底廢棄,沒有提供更新版本。API被廢棄的一些緣由是:
因爲費用緣由,該服務再也不受支持
公司決定將資源投資於不一樣產品
該服務再也不符合業務目標
這些決策一般能夠歸結爲業務策略,以及API與公司收入或用戶獲取目標的一致性。儘管這個決定很困難,可是許多團隊仍是必需要通過必定的時間。安全

如何有效地棄用API

棄用是API的最後階段,應謹慎行事。這可能會給最終用戶帶來不少挫敗感,而且在某些狀況下,可能會致使整個產品停產。這裏有一些指導方針,以更好地作到這一點。併發

**誠實溝通 **
當決定棄用API時,請對API的使用者保持開放和誠實。發送消息宣佈預期的棄用,包括棄用時間範圍,下一版本發佈時間表以及其餘信息(如支持,聯繫信息等)。這時API管理工具能夠迅速派上用場的地方是查看訪問使用API的用戶列表。也能夠在API開發人員門戶及其文檔中進行通訊。例如,Eolinker開放平臺,支持查看API用戶列表。
工具

提供足夠長的棄用時間
在最初宣佈棄用API以後的這段時間裏,給API使用者時間從新配置他們的應用程序。一個好的棄用期很重要,由於它使依賴API的公司有時間來更改業務和技術策略。根據已棄用的API的覆蓋範圍,用戶羣和服務產品的不一樣,這段時間可能在3-8個月之間。
版本控制

有效版本
使用有效的版本控制,能夠更輕鬆地棄用特定版本的API。有了良好的版本控制,還能夠同時使用不一樣版本的API。在徹底棄用該API以前,構建併發布該API的下一版本。這與棄用期有關,爲開發人員和工程師提供足夠的時間來重作現有體系結構支持新的API。 Eolinker具備一個API版本控制系統,該系統容許同時存在API的多個版本和迭代,這是向最終用戶提供有關API存在的各類版本以及推薦使用的版本的信息的最佳方法之一。
資源

提供替代方案
許多應用程序和全面的軟件解決方案都依賴於API才能正常運行。一個良好的遷移計劃,可使API使用者平穩過渡到API的最新版本,或者在徹底刪除API的狀況下過渡到其餘替代方案,這能夠幫助減輕挫敗感並維護最終使用者之間的信任。開發

總而言之,團隊應該考慮爲何,什麼時候以及如何禁用對API(不管是版本仍是整個服務自己)的支持。都應該花費時間和精力經過提供正確的信息,正確的資源和正確的時間來幫助最終用戶得到回報。最後,應該投資正確的工具和基礎設施,管理、更新和最終淘汰不一樣版本的API。
本文使用Eolinker進行演示,如需瞭解更多請訪問:www.eolinker.com文檔

相關文章
相關標籤/搜索