写的什么？
当初开发都要用到接口文档。不写的话代码不晓得怎么保护，写的话又费时费力，更烦人的是有时候写完了前端还要来问这个参数那个参数，真的苦不堪言。
在前后端拆散的近几年，写接口文档对我来说是老大难，前面特地去查了自动化工具的实践，才茅塞顿开。至多对于写文档的思路清晰了许多！
那么当初就来分享一下我怎么做的吧！
要做什么？
咱们的指标，是写出清晰简练的文档。所以，首先咱们要确定：怎么才是清晰简练的文档。
如下图所示：
下面的文档简练在哪？
首先，让你晓得它的性能，参数，高深莫测；
其次，你输出参数就能马上看到后果。
我心愿的是在实现代码后，能够费很少的力量，就生成一个像上图所示的可调试文档。
那么接下来要做两件事：
1、主动生成可视化的文档；
2、文档可调试。
怎么合作？
一是能够间接在工具里实现整个我的项目，二是导出不同格局的我的项目文档，可用于其余文档工具。
结语
我实现的工具是 Eolinker
应用地址是：www.eolinker.com
相似的工具有很多，swagger editor，gwsee，apidoc，都还能够。
写这篇文章不是举荐什么工具，然而本人走过一遍，必定会有播种哈哈:)