你注意到了嗎?修改API文檔也需要規範!

關於API介面文檔的內容和格式規範的文章,之前也有寫過,網上也有不少寫的比我還好的,就不贅述了,今天想說的是一個很容易被忽略的點,修改API文檔的規範:版本控制。

示例

拿Eolinker來演示一下流程,我們在通過API文檔完成當前的API項目後,新增了一個需求,需要修改某個介面。
這時候可以新建API版本,給變動後的介面設置版本號,得到修改前和修改後的不同版本API。

同時,Eolinker有自動生成和綁定不同版本API文檔的功能,完成API項目後,會自動生成規範的API文檔,並給不同的版本綁定不同的API文檔。通過Eolinker生成的API文檔支援在線查看,也支援不同格式的文檔導出和對比。


結言

一套成熟的API文檔,是不允許隨意修改介面的,隨意修改API文檔,很容易造成開發進度和項目的混亂。這時候比較規範的方法,就是加入版本控制了。
演示工具:www.eolinker.com