比Swagger2更好用的自动生成文档工具？对比流程说话！

肯定会有同学问为什么要自动生成文档，老惯例先解释一下应用场景。 现在的开发模式，通常都是先写接口文档再开发接口，但是需求不是一成不变的，接口也会有修改。相应的，改完接口就要改文档，这种时候会出现什么问题呢？没错了，接口文档会没有及时改或者忘了改。 所以就要想办法了啊，怎么改接口就自动生成对应的文档呢？那时候也是在某社区看到的帖子，然后就开始用Swagger2对应的自动生成接口文档功能了。 然后最近因为部门其他组的安利，换了个工具叫Eolinker，发现比Swagger简单不少，还支持直接通过Swagger导入API项目，帮助我们自己小组也解决了换工具麻烦的问题。

Swagger自动生成文档流程

我们当时是用Spring boot来做的，算是搭建比较快的，分为3步： 1.在pom.xml中添加依赖； 2.编写Swagger2的config； 3. 在controller中添加注解。 下面是实际的效果图。

Eolinker自动生成文档流程

使用Eolinker，只需要直接敲代码，符合正确的规范就可以自动生成接口文档，下面是几种比较简单的方法。 1.根据代码模板自动生成，直接新建模板编辑填入就可以在需要的时候自动生成；

2.导入/关联其他API工具自动生成，支持识别Swagger2、码云、github等；

下面是实际的效果图。

总结

Eolinker算是国产API工具里开发功能和后续支持服务都做得挺好的了，之前Swagger出了问题等客服的反馈真的一言难尽。我们用的是免部署的Saas版本，可能过段时间在公司内推开了会转成私有化部署的，强烈安利一下大家也可以试用一下。 使用地址：www.eolinker.com