用apifox替换Swagger@杨章隐

1. 公司用了很长时间的Swagger，首先Swagger是很好，但是随着时间推移，公司的单体项目越来越大，每次改一下字段的备注都要重新部署，侵入性太强了，影响的范围也越来越大。

2. 推荐：

1. 其实国内国外开放的接口管理工具很多像是谷歌开源又闭源又免费又收费又改回部分免费的eolink，接口文档需要手写，麻烦

2. yapi，之前有一家公司用这个，不过界面有点尬，支持idea插件一键同步。

3. apifox，有工具，有网页端口，界面还行，并且还有许多开放文档，也支持idea插件一键同步

3. 如何使用apifox替换Swagger

• 首先就不用单独剔除Swagger

Apifox 已推出 IDEA 插件 「Apifox Helper」 。Apifox Helper 是一款集成在 IDEA 中，帮助开发者自动解析代码注解并快速生成 API 文档的便捷工具。Apifox Helper 是基于 javadoc（Java）、KDoc（Kotlin）、ScalaDoc（Scala）解析 API 文档，支持 Spring Boot、Swagger、JAX-RS 等协议框架，基本可以实现代码零入侵自动生成接口文档。

在 IDEA 中使用 Apifox Helper 可以一键同步文档到 Apifox 项目中，开发者无需切换工具，即可更新同步文档给团队内其他人员。自动解析注解、快速同步文档、IDEA 内调试、Apifox 便捷团队协作，你只需一个「Apifox Helper」。

接下来给大家演示如何使用。

安装 & 配置

首先，需要在 IntelliJ IDEA 安装并且配置令牌。打开 Preferences(Settings) > Plugins ，搜索 Apifox Helper 点击安装即可。

你也可以从 Jetbrains Marketplace 的官网下载安装。

安装成功后，要将 IDEA 内的项目与 Apifox 的项目进相关联，需要配置令牌。进入设置界面 Preferences(Settings) > Apifox Helper 中填写 Apifox 服务器地址、个人访问令牌、项目 ID：

1. Apifox 服务器地址：默认 Apifox API 服务地址为 https://api.apifox.cn，无需修改。

2. Apifox 个人访问令牌：在 Apifox 个人头像处的「账号设置 --> API 访问令牌」，新建令牌后复制生成的 Token 填写即可。

3. 模块项目 ID 配置：这项主要是进行代码模块名和项目 ID 的映射关系配置，在 Apifox 中进入项目中「项目设置 --> 基本设置」，复制项目 ID 粘贴过来。

完成以上配置操作，就可以实现文档自动生成、同步、在线调试、导入导出等功能了。

自动生成 API 文档

使用「Apifox Helper」可直接自动解析代码注解，代码零入侵。右键点击「 Upload to Apifox」即可生成完整的 API 文档并同步到 Apifox 项目中，无需导出操作。团队成员即可在 Apifox 项目中完成接口调试、自动化测试等工作。

接口信息一键更新同步

当在 IDEA 项目中有接口信息变动，只需右键点击「 Upload to Apifox」一键即可完成同步，无需奔走相告。团队成员可在 Apifox 中看到同步后的最新内容。

此外，使用 Apifox Helper 可以在 IDEA 中一键发起接口内测，同时支持导出 Markdown 格式文档和 cURL，适应不同团队的协作方式。

结合 IDEA 插件，我们推荐代码先行的团队 API 协作实践方式如下：

• 后端开发者：在 IDEA 中安装 「Apifox Helper」，随时编写/调试，随时更新同步；

• 前端开发者：在 Apifox 中查看最新文档，进行接口调试、API Mock ；

• 测试工程师：在 Apifox 中获取最新接口信息，编写/保存测试用例、进行自动化测试。

让后端开发者只需一个「Apifox Helper」即可在 IDEA 中完成 API 协作所需的工作。

通过这个教程，基本上我们可以很快的同步完所有文档，对于大部分已经有的标准文档我们可以缓慢过过渡到apifox。