首页 > 其他分享 >Apifox IDEA 插件 | 帮助开发者快速生成 API 文档!

Apifox IDEA 插件 | 帮助开发者快速生成 API 文档!

时间:2023-02-20 16:07:23浏览次数:50  
标签:插件 Helper IDEA 令牌 API 文档 Apifox

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

Apifox IDEA 插件 | 帮助开发者快速生成 API 文档!_开发者

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

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

安装 & 配置

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

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

Apifox IDEA 插件 | 帮助开发者快速生成 API 文档!_API文档_02

安装成功后,要将 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 粘贴过来。

Apifox IDEA 插件 | 帮助开发者快速生成 API 文档!_自动生成_03

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

自动生成 API 文档

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

Apifox IDEA 插件 | 帮助开发者快速生成 API 文档!_开发者_04

接口信息一键更新同步

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

Apifox IDEA 插件 | 帮助开发者快速生成 API 文档!_开发者_05

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

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

  • 后端开发者:在 IDEA 中安装 「Apifox Helper」,随时编写/调试,随时更新同步;
  • 前端开发者:在 Apifox 中查看最新文档,进行接口调试、API Mock ;
  • 测试工程师:在 Apifox 中获取最新接口信息,编写/保存测试用例、进行自动化测试。

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

Apifox IDEA 插件 | 帮助开发者快速生成 API 文档!_开发者_06


标签:插件,Helper,IDEA,令牌,API,文档,Apifox
From: https://blog.51cto.com/u_15964010/6068605

相关文章

  • API接口聚全,价监控,订单接口,json格式数据
    行业背景:电商行业数据分析api接口,品牌监控api接口,商品价格监控api接口,电商数据采集,对品牌和电商企业推出的的数据分析产品,致力于帮助品牌方全面掌握市场行情和趋势,定位竞争......
  • css的z-index和微信小程序的API及React知识点
    变量的三个基本要素:类型+名称+值 devDependencies与dependencies区别:devDependencies里面的依赖只用于开发环境,不用于生产环境。而dependencies依赖的包不仅开发环......
  • git的常规使用 - Idea集成GitHub
    git概要创建远程仓库代码克隆代码推送代码拉取GitHub官网:https://github.com1.创建远程仓库1.1登录github1.2创建仓库登录之后点击右上角+号,Newrepositor......
  • Idea Diff工具介绍
    背景项目中有大量的数据对比工作,需要生成文件,与旧文件进行对比,自动化对比和手工对比验证,自动化对比采用java-diff工具类或者手动去除换行空格注释,进行字符串对比,手动化对......
  • git设置不提交指定文件-解决idea的.gitignore有时不起作用的问题
    有时候,.gitignore会对部分文件/文件夹失效,大概原因是由于新创建的文件已经出现在git本地仓库的缓存,所以.gitignore就失效了解决办法就是清空一下git仓库的缓存,重新提交一次......
  • IDEA
     10:05AM Lowmemory TheIDEisrunninglowonmemoryandthismightaffectperformance.Pleaseconsiderincreasingavailableheap. Analyzememoryus......
  • 项目一众筹00_06Maven概念:仓库、生命周期、插件和目标、如何导入已经存在的maven项目
    系列文章目录文章目录​​系列文章目录​​​​仓库​​​​生命周期​​​​插件和目标​​​​如何导入已经存在的maven项目​​仓库具体可看前面几篇文章,有详细说明这就......
  • 如何在eclipse上查看源码,如果在idea查看源码【待完善】
    如何查看源码目录文章目录​​如何查看源码目录​​​​如何在eclipse上查看String的源码目录​​​​如何在idea上查看String的源码目录【待完善】​​如何在eclipse上查看......
  • 基于ChatGPT的API的C#接入研究
    今年开年,最火的莫过于ChatGPT的相关讨论,这个提供了非常强大的AI处理,并且整个平台也提供了很多对应的API进行接入的处理,使得我们可以在各种程序上无缝接入AI的后端处理,从而......
  • jQuery-插件机制
    jQuery-插件机制增强JQuery的功能1.实现方式:1.$.fn.extend(object)增强通过Jquery获取的对象的功能$("#id)2.$.extend(object)......