关于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
本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享; 2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关; 3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关; 4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除; 5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。