关于API接口文档的内容和格式规范的文章，之前也有写过，网上也有不少写的比我还好的，就不赘述了，今天想说的是一个很容易被忽略的点，修改API文档的规范：版本控制。

示例

拿Eolinker来演示一下流程，我们在通过API文档完成当前的API项目后，新增了一个需求，需要修改某个接口。
这时候可以新建API版本，给变动后的接口设置版本号，得到修改前和修改后的不同版本API。

同时，Eolinker有自动生成和绑定不同版本API文档的功能，完成API项目后，会自动生成规范的API文档，并给不同的版本绑定不同的API文档。通过Eolinker生成的API文档支持在线查看，也支持不同格式的文档导出和对比。

结言

一套成熟的API文档，是不允许随意修改接口的，随意修改API文档，很容易造成开发进度和项目的混乱。这时候比较规范的方法，就是加入版本控制了。
演示工具：www.eolinker.com

标签：Eolinker,规范,接口,修改,API,文档
来源： https://www.cnblogs.com/dc20181010/p/14744854.html