共计 1848 个字符，预计需要花费 5 分钟才能阅读完成。
每个开发都不想写文档。当你不想写接口文档时，能够通过装置插件在 IDEA 里实现主动同步，一边写代码一边同步接口文档给你的前端、测试同学。以下内容手把手教你怎么操作（这里仅面向应用 IDEA 编辑器、遵循 Java Spring 框架正文标准的同学）：
首先，你须要装置一个插件
IDEA 插件市场里搜寻「Apifox Helper」，这是国内一个做 API 合作治理平台的厂商（Apifox）做的插件，能够十分不便主动生成接口文档并且同步到你的我的项目中。这个插件能够实现代码零入侵自动生产接口文档。
- IDEA 装置插件：关上 IDEA > Preferences(Settings) > Plugins，搜寻 Apifox Helper，点击装置。这里如果存在装置速度慢，你也能够去 Jetbrains Marketplace 的官网下载。
装置实现后，你能够抉择同步到 Apifox 我的项目中，也能够间接导出 markdown 文档。如果是同步到 Apifox 我的项目，你还须要下载或注册 Apifox 软件，创立一个对应的我的项目：
- 注册 / 下载地址：http://apifox.cn，间接微信扫一扫就能够，非常简单。
- 创立我的项目：点击创立团队 > 新建我的项目，填入对应的项目名称。
（这里强烈推荐同步到 Apifox 我的项目，起因前面说）
第二步，把你 IDEA 中的我的项目和 Apifox 的我的项目关联
插件装置胜利后，要将 IDEA 内的我的项目与 Apifox 的我的项目进行相关联，须要配置令牌。在 IDEA 中进入插件设置界面 Preferences(Settings) > Apifox Helper 中填写即可。须要填写的根底信息有三个：
- Apifox 服务器地址：默认 Apifox API 服务地址为 https://api.apifox.cn，默认就填好了，不须要批改。
- 填写 Apifox 集体拜访令牌：在 Apifox 个人头像处的【账号设置】中抉择【API 拜访令牌】，新建令牌后复制生成的 Token 填写到以上插件设置中。
- 模块我的项目 ID 配置：这项次要是进行代码模块名和我的项目 ID 的映射关系配置，在 Apifox 中对应我的项目的【我的项目设置】中抉择【根本设置】，复制并保留我的项目 ID，填写在以上的对应模块名处。
-
到这里，就实现全副的设置动作，能够实现文档的主动生成和更新同步了。阐明一下：每个我的项目只须要开始的时候设置这一次，前面就不须要做这个操作了。
第三步，主动生成接口文档
- 关上须要上传的 Controller 文件，右键抉择「Upload to Apifox」。
-
- 去 Apifox 我的项目内，就能够看到方才主动同步过去的文档了。
- 当后续接口代码有变动或更新时，再次点击「Upload to Apifox」就能够同步。
为什么举荐创立一个 Apifox 我的项目？
这个插件尽管反对导出 markdown，但给他人分享分档的时候不是很不便，有更新的时候也不会同步，须要重复导出。应用 Apifox 我的项目就能够间接给他人分享一个链接就能够，你之后接口的更新也会间接同步，对方看到的永远是最新的。另外，Apifox 这个产品自身还有很丰盛的 API 调试、Mock、自动化测试等性能，你的前端和测试也能够间接在下面做后续的工作了。这里不细说，有趣味的能够去找他们官网文档理解。
有了这个插件，你还能够间接在 IDEA 里调试
Apifox Helper 反对在 IDEA 中一键发动接口自测，不须要切换其他软件。在 IDEA 中选中须要调试的 API 文件，右键抉择「Call API」发动申请就能够。
当然，以上只是简略版本的主动同步文档，没有什么非凡状况也就能够满足应用了。当然，可能会存在一些非凡的要求，比如说，设置接口 API 所在的文件夹名称、想要疏忽某些 API 不同步等等状况。在他们的官网文档上是举荐应用配置文件的形式实现你各种非凡规定和要求的。详情能够自行去 Apifox 官网查阅。
和 Swagger 有啥不一样？
很多开发都习惯用 Swagger，用 Swagger 能够肯定水平上解决主动生成文档的问题，但有一个很大的毛病：你须要写大量的正文，会对你的逻辑代码有入侵。并且在性能的全面性上不如 Apifox。
Swagger：须要写正文，对逻辑代码有入侵，性能繁多；
Apifox：能够根本实现代码零入侵，应用规范的 Javadoc 正文就能够主动生成。同时它也反对同步 Swagger 的文档到我的项目里。还有 API Mock、自动化测试等延长性能。
举荐用法是能够省略 Swagger 这一步，间接装置这个插件应用就能够。
下载链接：www.apifox.cn