目录

前言

安装Apifox

 Idea插件安装

插件令牌配置

获取令牌

Idea配置令牌

快速上手

同步文档

查看文档

结语：

---

前言

    最近发现一款特别好用的插件，帮助开发者快速生成接口文档。ApifoxHelper插件实现代码零侵入，只需要写上相应注释即可。

安装Apifox

    官网链接，下载之后无脑安装即可Apifox - API 文档、调试、Mock、测试一体化协作平台。拥有接口文档管理、接口调试、Mock、自动化测试等功能，接口开发、测试、联调效率，提升 10 倍。最好用的接口文档管理工具，接口自动化测试工具。https://apifox.com/

 Idea插件安装

    点击Plugins进行插件安装

插件令牌配置

获取令牌

    依次点击Apifox，账号设置 -> API访问令牌 -> 新建令牌，完成之后可以得到一串字符，它就是令牌了。 

Idea令牌配置

    依次点击，Settings -> ApifoxHelper -> 上传，完成之后进入配置页面。将刚生成的令牌粘贴到Api访问令牌位置处，点击测试令牌，如果显示成功则说明配置完成。

快速上手

同步文档

    1）模块内的全部接口：在左侧目录树的模块节点，点击右键，选择「Upload to Apifox」

    2）Controller 内的全部接口：在 Controller 文件内部，点击右键，选择「Upload to Apifox」

    1）如果是首次同步，需要在弹出的对话框内选择接口的目标同步项目，你可以选择项目或项目内的目录。如果选择项目，则将会上传至项目的根目录。

    2）数据模型无需配置，API 文档将默认上传至接口所在项目的数据模型根目录。

    可在团队中创建项目，找到团队中该项目，点击OK即可同步，看到以下日志则同步成功。 

查看文档

    完成以上步骤，即可在Apifox中看到接口文档

结语

    在同步接口文档时，实体类以及接口注释需要写完整。Apifox功能是非常全乎的，例如分享文档，自动化测试，分支管理等等，值得大家一试！

    详情操作请看官方文档

Apifox IDEA 插件快速上手 | Apifox 帮助文档Apifox Helper 是 Apifox 团队针对 IntelliJ IDEA 环境所推出的插件，可以在 IDEA 环境中识别本地 Java、Kotlin 后端项目的源代码，自动生成 API 文档并一键同步到 Apifox 的项目中。https://apifox.com/help/applications-and-plugins/idea/start