共计 1174 个字符，预计需要花费 3 分钟才能阅读完成。
你还在用 word、markdown 埋头苦干写 接口文档？写文档这件事恐怕是每个开发都万分抗拒的事件了。本篇文章具体教你如何利用插件工具，在 IDEA 中主动生成 API 文档。
先来看看从 IDEA 中生成文档的成果如下图。下图是应用 Apifox 插件（Apifox helper）从 IDEA 生成的文档（右）成果。
第一步：装置插件
关上你的 IDEA，点击 File –>Settings –> Plugins, 输出 Apifox Helper。 点击装置，而后期待胜利后重启 IDEA.
你也能够通过 Jetbrains Marketplace 的官网下载安装。
第二步：注册一个 Apifox 账号
Apifox 是一个在线的接口文档管理工具，这一步次要是用来同步文档到我的项目中。反对下载桌面端或间接网页注册，并且创立一个我的项目。
第三步：配置令牌
接下来，你须要将 Apifox Helper 和 Apifox 的我的项目进行关联，也就是通过拜访令牌绑定。
1、关上 Apifox，点击左侧【头像】–>【账号设置】–>【API 拜访令牌】；
2、点击【新建令牌】，填写令牌名称，点击【保留并生成令牌】。
3、复制令牌到 IDEA 中【Apifox Helper】配置项的 API 拜访令牌中。同理，在 Apifox 中进入我的项目，【我的项目设置 –> 根本设置】，复制我的项目 ID。
4、在 IDEA 中，点击 File–>Settings –>Other Settings，找到 Apifox Helper。 将拜访令牌和我的项目 ID 粘贴到这里：
（服务器地址就用默认的，能够不必管。）
到这里，你就搞定了配置局部，上面就是主动生成文档了！
第四步：生成文档！
关上须要上传的 Controller 文件，右键抉择「Upload to Apifox」。
第五步：去 Apifox 我的项目中查看主动生成的文档
点击 Apifox 右上角的刷新图标。方才在 IDEA 我的项目中的接口文档就曾经在这里了。
自此，你就功败垂成了！祝贺你曾经领有了一份好看整洁的接口文档。这个我的项目一旦有更新，你只须要右键点击「Upload to Apifox」就能够。
更多好用的性能
当你的文档同步到我的项目中，那么你就能够间接在 apifox 中间接生成一个分享链接给他人，那么他看到的文档就都是最新的，不须要再管你索要接口文档文件。
还能够间接在 Apifox 我的项目中间接发动接口调试、接口自动化测试等等操作。相较于 Postman，Apifox 联合它的插件 Apifox Helper 能够通过代码注解主动解析生成 API 文档，无需手动操作，同时反对远端同步，十分不便团队内的合作和更新。这是一种新型的在线合作形式，可能十分高效率帮忙你进行 API 接口的分享和治理。懒人必备！另附带 Apifox 插件官网帮忙文档，帮忙你应用。
更多对于接口文档的相干常识。：
- 高效实用的办法，让程序员爱上写接口文档
- 接口文档谁来写？
