API版本管理與變動通知

API的研發是一個周而復始的過程,隨着技術的發達,開發週期逐漸縮短,每每在短期內就可對API進行研發迭代,雖然這樣作有利於快速完善產品,但版本變動迭代管理成爲了一大麻煩。api

爲何須要更改API

更改API是一件很是基本的事情,但更改API其實是更改與用戶之間的通訊,關鍵還不能影響現有的環境,同時更改API也在所不免。更改API不單單會影響API的內容,如請求或響應的格式,也能夠包括API的功能。不管API最初設計的多麼出色,隨着時間的流逝,必須對其進行更改。
安全

管理API版本的好處

既然咱們須要優化或頻繁更改API,那麼每進行一次更改就有必要生成一條記錄,方便系統進行快速回滾的同時,有助於開發人員更好的理解每個版本,並考慮如何讓系統更好的發展。
工具

每一次迭代都須要通知到相關的工做人員,例如測試或市場運營,測試人員須要對當前版本的API進行測試,而市場人員則須要對用戶進行介紹最新的功能。
測試

在API的生命週期中,API版本管理與API的安全性相關聯。版本記錄越詳細,API的安全性也更加全面,而且還可以經過更全面的日誌信息發現問題,進行測試與交付。
優化

結語

是的,API版本管理確實很難,不只要保證系統穩定,同時還要求及時將信息同步給全部關聯的人員。爲了後期方便對API版本進行管理,咱們在設計API初期時就應該詳細設計版本號,並考慮協助人員的合做與涉及人員的通知等各個方面。設計

演示工具爲Eolinker,一個國產API整合管理工具。
使用地址:www.eolinker.com日誌

相關文章
相關標籤/搜索