关于后端:Apifox-IDEA-插件-帮助开发者快速生成-API-文档

44次阅读

共计 1417 个字符,预计需要花费 4 分钟才能阅读完成。

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 合作所需的工作。

当初登程,在 IDEA 内「plugin」入口搜寻「Apifox Helper」下载试试吧!

想理解更多对于插件的内容能够 返回 Apifox 官网帮忙文档查看

除了 IDEA 插件,近期咱们还新增了许多其余性能,欢送返回理解:Apifox 1 月产品新性能解读。

正文完
 0