API版本管理中的溝通問題

產品升級會涉及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