还在纠结接口文档的事儿呢？

写的什么？

现在开发都要用到接口文档。不写的话代码不知道怎么维护，写的话又费时费力，更烦人的是有时候写完了前端还要来问这个参数那个参数，真的苦不堪言。 在前后端分离的近几年，写接口文档对我来说是老大难，后面特地去查了自动化工具的理论，才茅塞顿开。至少对于写文档的思路清晰了许多！ 那么现在就来分享一下我怎么做的吧！

要做什么？

我们的目标，是写出清晰简练的文档。所以，首先我们要确定：怎么才是清晰简练的文档。 如下图所示：

上面的文档简练在哪？

首先，让你知道它的功能，参数，一目了然； 其次，你输入参数就能马上看到结果。

我希望的是在完成代码后，可以费很少的力气，就生成一个像上图所示的可调试文档。 那么接下来要做两件事： 1、自动生成可视化的文档； 2、文档可调试。

怎么协作？

一是可以直接在工具里完成整个项目，二是导出不同格式的项目文档，可用于其他文档工具。

结语

我实现的工具是Eolinker 使用地址是：www.eolinker.com 类似的工具有很多， swagger editor，gwsee，apidoc，都还可以。 写这篇文章不是推荐什么工具，但是自己走过一遍，肯定会有收获哈哈:)