產品升級會涉及API的更改,當API改動較大時,最大的問題是如何通知API的使用者(內部人員與使用OPENAPI 的用戶),我們不能強迫所有用戶立即對API的更改做出調整,但是也不能無限期的使用舊版本的API,

所以,一旦在生產環境中運行了多個API版本,通知使用者升級則成了一個大問題,復雜程度也與使用者的規模有關,意識到任何重大的更改對API的潛在影響,保持與用戶群良好的關系至關重要,
盡管沒有明確的規定多長時間需要更新API版本,但是考慮到整個團隊,強烈建議在任何給定的時間內生產中的主要API版本永遠不要超過兩個,這可以讓團隊每次需要升級版本時都具有一致且可靠的轉換程序,而不必擔心管理太多且看似隨機的API,

不管給定多少版本的API,清楚的傳達與API版本更新相關的時間和更改內容是確保順利升級的關鍵,API棄用通知應該盡早發送給使用者,通常是在新的API版本準備發布前,訊息應包括所有內容,例如正在進行的更改,影響到哪些更新,使用者需要采取哪些操作來避免任何出現的問題,

如何才能快速并且及時的通知用戶API更新資訊,由于使用用戶的環境不同,有些用戶是離線環境,有些則是規定使用某一型別檔案,導致API檔案有很多種形式,例如:HTML、WORD檔案、EXCEL檔案…還包括一些熱門的在線檔案、API檔案工具,如swagger、eolinker等,如果您的檔案以某一格式型別存在,制作一份檔案則需要制作不同格式而內容相同的檔案,作業量是很大的,

API檔案工具可以幫助我們解決以上問題,以Eolinker為例,在保持檔案清晰可讀的同時,Eolinker可以在線分享檔案,或匯出多種格式檔案,并支持通知…大大降低了作業量,Eolinker是一個適配不同規模團隊的Saas工具,同時也支持私有化部署,
使用地址:www.eolinker.com
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/231798.html
標籤:其他
上一篇:介面測驗要測驗什么?要怎么測?
