Apifox IDEA 插件 | 幫助開發(fā)者快速生成 API 文檔！
Apifox 已推出 IDEA 插件 「Apifox Helper」 。Apifox Helper 是一款集成在 IDEA 中，幫助開發(fā)者自動(dòng)解析代碼注解并快速生成 API 文檔的便捷工具。?Apifox Helper 是基于 javadoc（Java）、KDoc（Kotlin）、ScalaDoc（Scala）解析 API 文檔，支持 Spring Boot、Swagger、JAX-RS 等協(xié)議框架，基本可以實(shí)現(xiàn)代碼零入侵自動(dòng)生成接口文檔。
在 IDEA 中使用 Apifox Helper 可以一鍵同步文檔到 Apifox 項(xiàng)目中，開發(fā)者無需切換工具，即可更新同步文檔給團(tuán)隊(duì)內(nèi)其他人員。自動(dòng)解析注解、快速同步文檔、IDEA 內(nèi)調(diào)試、Apifox 便捷團(tuán)隊(duì)協(xié)作，你只需一個(gè)「Apifox Helper」。
接下來給大家演示如何使用。
安裝 & 配置
首先，需要在 IntelliJ IDEA 安裝并且配置令牌。打開 Preferences(Settings) > Plugins ，搜索 Apifox Helper 點(diǎn)擊安裝即可。
你也可以從 Jetbrains Marketplace 的官網(wǎng)下載安裝。
安裝成功后，要將 IDEA 內(nèi)的項(xiàng)目與 Apifox 的項(xiàng)目進(jìn)相關(guān)聯(lián)，需要配置令牌。進(jìn)入設(shè)置界面 Preferences(Settings) > Apifox Helper 中填寫 Apifox 服務(wù)器地址、個(gè)人訪問令牌、項(xiàng)目 ID：
Apifox 服務(wù)器地址：默認(rèn) Apifox API 服務(wù)地址為?*https://api.apifox.cn*，無需修改。
Apifox 個(gè)人訪問令牌：在 Apifox 個(gè)人頭像處的「賬號(hào)設(shè)置 --> API 訪問令牌」，新建令牌后復(fù)制生成的 Token 填寫即可。
模塊項(xiàng)目 ID 配置：這項(xiàng)主要是進(jìn)行代碼模塊名和項(xiàng)目 ID 的映射關(guān)系配置，在 Apifox 中進(jìn)入項(xiàng)目中「項(xiàng)目設(shè)置 --> 基本設(shè)置」，復(fù)制項(xiàng)目 ID 粘貼過來。
完成以上配置操作，就可以實(shí)現(xiàn)文檔自動(dòng)生成、同步、在線調(diào)試、導(dǎo)入導(dǎo)出等功能了。
自動(dòng)生成 API 文檔
使用「Apifox Helper」可直接自動(dòng)解析代碼注解，代碼零入侵。右鍵點(diǎn)擊「 Upload to Apifox」即可生成完整的 API 文檔并同步到 Apifox 項(xiàng)目中?，無需導(dǎo)出操作。團(tuán)隊(duì)成員即可在 Apifox 項(xiàng)目中完成接口調(diào)試、自動(dòng)化測(cè)試等工作。
接口信息一鍵更新同步
當(dāng)在 IDEA 項(xiàng)目中有接口信息變動(dòng)，只需右鍵點(diǎn)擊「 Upload to Apifox」一鍵即可完成同步，?無需奔走相告。團(tuán)隊(duì)成員可在 Apifox 中看到同步后的最新內(nèi)容。
此外，使用 Apifox Helper 可以在 IDEA 中一鍵發(fā)起接口內(nèi)測(cè)，同時(shí)支持導(dǎo)出 Markdown 格式文檔和 cURL，適應(yīng)不同團(tuán)隊(duì)的協(xié)作方式。
結(jié)合 IDEA 插件，我們推薦代碼先行的團(tuán)隊(duì) API 協(xié)作實(shí)踐方式如下：
后端開發(fā)者：在 IDEA 中安裝 「Apifox Helper」，隨時(shí)編寫/調(diào)試，隨時(shí)更新同步；
前端開發(fā)者：在 Apifox 中查看最新文檔，進(jìn)行接口調(diào)試、API Mock ；
測(cè)試工程師：在 Apifox 中獲取最新接口信息，編寫/保存測(cè)試用例、進(jìn)行自動(dòng)化測(cè)試。
讓后端開發(fā)者只需一個(gè)「Apifox Helper」即可在 IDEA 中完成 API 協(xié)作所需的工作。
現(xiàn)在出發(fā)，在 IDEA 內(nèi) 「plugin」入口搜索「Apifox Helper」下載試試吧！
想了解更多關(guān)于插件的內(nèi)容可以前往 Apifox 官方幫助文檔查看：www.apifox.cn
