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:
- Apifox 服务器地址:默认 Apifox API 服务地址为 https://api.apifox.cn,无需修改。
- Apifox 个人访问令牌:在 Apifox 个人头像处的「账号设置 --> API 访问令牌」,新建令牌后复制生成的 Token 填写即可。
- 模块项目 ID 配置:这项主要是进行代码模块名和项目 ID 的映射关系配置,在 Apifox 中进入项目中「项目设置 --> 基本设置」,复制项目 ID 粘贴过来。
完成以上配置操作,就可以实现文档自动生成、同步、在线调试、导入导出等功能了。
自动生成 API 文档
使用「Apifox Helper」可直接自动解析代码注释,代码零入侵。右键点击「 Upload to Apifox」即可生成完整的 API 文档并同步到 Apifox 项目中,无需导出操作。团队成员即可在 Apifox 项目中完成接口调试、自动化测试等工作。