Loading [MathJax]/jax/output/CommonHTML/config.js
前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >【Apifox Helper】自动生成接口文档,IDEA+Apifox懒人必备

【Apifox Helper】自动生成接口文档,IDEA+Apifox懒人必备

原创
作者头像
JavaDog程序狗
发布于 2024-10-13 03:33:00
发布于 2024-10-13 03:33:00
5640
举报
文章被收录于专栏:开发工具开发工具

前言

🍊缘由

接口文档对接爽,整理起来真费脑

对于整理API文档,本狗秉承偷懒为上的原则,想找一种在IDEA中直接生成文档的方法。Apifox Helper绝绝子,只需要在IDEA中下载插件,无脑配置后,文档自动生成到Apifox,美完美解决。并且颜值及方便程度绝比Swagger和postman好太多。

⏲️本文阅读时长

约10分钟

🥮前置条件

1. IDEA开发工具
2. Apifox(不必要)

🎯主要目标

一秒生成接口文档

🍩水图

IDEA中项目接结构图

想了解上图模块分层方法的同学,可以参考《还不会SpringBoot项目模块分层?来这手把手教你》

生成到Apifox接口文档图

👨‍🎓试用人群

1. 像本狗一样【偷懒】不愿意整理接口文档
2. 学习新颖文档生成及管理方式

正文

🐋1.在IDEA安装【Apifox Helper】插件

点击File=>Settings,找到Plugins,输入 Apifox Helper,点击安装,然后等待成功后重启IDEA,一定重启才会生效!!!

🎯Tips: 你可以选择同步到 Apifox 项目中,也可以直接导出 markdown 文档。如果是同步到 Apifox 项目,你还需要下载或注册 Apifox 软件,并查看下面【Apifox Helper】的配置规则。如果不需要则只需要在项目中找到需要生成文档的Controller,右键后Export Markdown,直接导出apifox-api.md到对应目录。

打开apifox-api.md文件查看


🦢2.修改【Apifox Helper】对应配置

点击File=>Settings=>Other Settings,找到 ApifoxHelper

1. Apifox服务器地址

https://api.apifox.cn

2. API访问令牌

打开Apifox软件,点击左侧【头像】,点击【账号设置】,找到API访问令牌


点击新建令牌,填写名称及有效期,本狗填写名称为【IDEA专用】,有效期为【无限期】,点击【保存并生成令牌】


复制令牌到IDEA中【Apifox Helper】配置项的API访问令牌

3. 模块项目ID配置

打开Apifox软件,新建项目,本狗项目名为【bkb】,并确认


进入项目【bkb】,点击【项目设置】,点击【基本设置】,复制项目ID


将上述复制的【ProjectID】到IDEA中【Apifox Helper】配置【模块项目ID配置】,我的ModuleName为【bkb-boot-controller】,所以结构是bkb-boot-controller:xxxxx,点击【OK】


🌈3.生成文档

右击【bkb-boot-controller】模块,点击 【Upload to Apifox】,等待完成即可


🍎4.查看Apifox中自动生成的文档

一定要点击下Apifox软件右上角的刷新!

一定要点击下Apifox软件右上角的刷新!

一定要点击下Apifox软件右上角的刷新!

查看成果,大功告成,之后便可为所欲为了


写在最后

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
超简单!Java 项目自动生成接口文档教程
你还在用 word、markdown 埋头苦干写接口文档?写文档这件事恐怕是每个开发都万分抗拒的事情了。本篇文章详细教你如何利用插件工具,在 IDEA 中自动生成 API 文档。
物立
2023/04/24
4.7K0
超简单!Java 项目自动生成接口文档教程
还手写文档?这个IDEA插件一键自动生成,爽!
每个开发都不想写文档。当你不想写接口文档时,可以通过安装插件在 IDEA 里实现自动同步,一边写代码一边同步接口文档给你的前端、测试同学。以下内容手把手教你怎么操作(这里仅面向使用 IDEA 编辑器、遵循 Java Spring 框架注释规范的同学):
一行Java
2023/02/23
1.4K1
还手写文档?这个IDEA插件一键自动生成,爽!
横空出世!IDEA 版 API 接口神器来了,一键生成文档!
每个开发都不想写文档。当你不想写接口文档时,可以通过安装插件在 IDEA 里实现自动同步,一边写代码一边同步接口文档给你的前端、测试同学。以下内容手把手教你怎么操作(这里仅面向使用 IDEA 编辑器、遵循 Java Spring 框架注释规范的同学):
物立
2023/02/20
3.7K0
横空出世!IDEA 版 API 接口神器来了,一键生成文档!
横空出世! IDEA 版 API 接口神器来了,一键生成文档
JetBrains公司的IntelliJ IDEA是一款非常受欢迎的Java集成开发环境,而Apifox Helper是一款IDEA插件,可以帮助开发者更快速地开发和调试应用程序。
Java king
2023/03/27
3K0
横空出世! IDEA 版 API 接口神器来了,一键生成文档
通过PHP注解Apidoc自动生成API接口文档在Webman框架
Apidoc 是一个通过解析注解生成Api接口文档的PHP composer扩展,兼容Laravel、ThinkPHP、Hyperf、Webman等框架。全面的注解引用、数据表字段引用,简单的注解即可生成Api文档,而Apidoc不仅于接口文档,在线接口调试、Mock调试数据、调试事件处理、Json/TypeScript生成、接口生成器、代码生成器等诸多实用功能,致力于提高Api接口开发效率。
Tinywan
2024/01/19
2K0
通过PHP注解Apidoc自动生成API接口文档在Webman框架
接口测试神器Apifox
Apifox = Postman + Swagger + Mock + JMeter
软件测试君
2020/09/07
1.5K0
接口测试神器Apifox
几个测试接口的好工具,效率加倍~
作为一名后端程序员,一定要对自己写的接口负责,保证接口的正确和稳定性。因此,接口测试也是后端开发中的关键环节。
程序员鱼皮
2023/10/23
9410
几个测试接口的好工具,效率加倍~
JApiDocs(自动生成接口文档神器)
注:官方文档中注明分组名称@description,但是实际应用中不需要加入注解,像下例所示,直接写注释即可。(类上写不写都行,方法上如果加上@description反而不显示) 例:
huofo
2022/03/18
1.3K0
JApiDocs(自动生成接口文档神器)
全自动生成!让你和接口文档说拜拜!!
平时已经加班加点去实现产品经理提出的复杂需求了,到最后还要写接口文档给前端的小伙伴对接,实在是让人有些沮丧 ε(┬﹏┬)3
永恒君
2022/12/06
3860
全自动生成!让你和接口文档说拜拜!!
简单快捷的分享操作:提升团队协作效率的利器 - Apipost 与 Apifox 之对比
在API驱动的现代软件开发中,接口文档的快速共享是团队协作的核心环节。然而,繁琐的文档分享流程可能导致跨部门沟通滞后、需求理解偏差,甚至延误项目交付。例如,某金融科技团队曾因接口文档传递效率低下,导致测试团队误用旧版接口参数,最终引发生产环境数据异常。由此可见,工具能否提供简单高效的文档分享功能,直接影响团队协作效率和项目质量。本文将以 Apipost 与 Apifox 为例,从功能设计、操作流程到实际场景,解析两者在分享操作上的差异及其对协作效率的影响。
用户11531559
2025/03/28
770
Spring-Boot + Swagger2 自动生成API接口文档
spring-boot作为当前最为流行的Java web开发脚手架,相信越来越多的开发者会使用其来构建企业级的RESTFul API接口。这些接口不但会服务于传统的web端(b/s),也会服务于移动端。在实际开发过程中,这些接口还要提供给开发测试进行相关的白盒测试,那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题。 假如你已经对传统的wiki文档共享方式所带来的弊端深恶痛绝,那么尝试一下Swagger2 方式,一定会让你有不一样的开发体验:
用户1212940
2022/04/13
6440
Spring-Boot + Swagger2 自动生成API接口文档
2021.8.13起,Github要求使用基于令牌的身份验证
remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.
Vam的金豆之路
2021/12/01
2.6K0
2021.8.13起,Github要求使用基于令牌的身份验证
支持Dubbo接口文档生成的工具!
点击上方蓝色“程序猿DD”,选择“设为星标” 回复“资源”获取独家整理的学习资料! 作者 | 肥朝 来源 | https://mp.weixin.qq.com/s/JW0yPtaIeyYZCs2PuucICQ Introduce smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念, 完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。你只需要按照java-doc标准
程序猿DD
2023/04/04
1.3K0
支持Dubbo接口文档生成的工具!
ApiPost 快速生成在线接口文档!!
ApiPost是一个支持团队协作,并可直接生成文档的API调试、管理工具。它支持模拟POST、GET、PUT等常见请求,是后台接口开发者或前端、接口测试人员不可多得的工具 。使用者不仅可以利用apiopst调试接口,还可以书写相关注释(接口文档),方便的生成可读性好、界面美观的在线接口文档。
XD
2022/05/15
3.9K0
接口调试与文档生成:Apipost 与 Apifox 的深度考量
在当今数字化时代,软件开发项目的复杂性与日俱增,团队协作和开发效率的重要性不言而喻。其中,“接口调试”和“文档生成”成为贯穿整个开发流程的核心环节,对项目进度及质量的影响深远。在众多开发工具中,Apipost 和 Apifox 凭借出色的功能被广泛关注。本文将从多个关键维度,对 Apipost 和 Apifox 在接口调试与文档生成功能上的表现进行深度对比分析,为开发团队的工具选型提供参考。
多吃核桃
2025/02/24
980
接口调试与文档生成:Apipost 与 Apifox 的深度考量
PostMan 快快走开, ApiFox 来了, ApiFox 强大的Api调用工具
为什么要用ApiFox呢, 一般现在程序员开发测试, 一般都是PostMan, PostWoman等Api调用工具, 我之前也是一直在用, 但是今天我发现了一款相比于Postman更加好用的工具, 那就是ApiFox, 是通过一款公众号推荐给我的, 我开始还不以为然, 但是在仔细阅读后, 发现真的非常好用, 下面让我们来了解ApiFox
彼岸舞
2022/06/02
1K0
PostMan 快快走开, ApiFox 来了, ApiFox 强大的Api调用工具
Apifox是个啥?
大家好,我是码农飞哥---作为一名后端老码农,我做的大部分项目一般都是基于 Swagger 来管理 API 文档,基于 Postman 来做接口调试,基于 JMeter 来做接口性能测试,基于RAP 等工具 Mock API 数据。
码农飞哥
2024/01/03
5690
Apifox是个啥?
Vuepress + GitHub Actions 实现博客自动部署!
正常我们利用 Vuepress 搭建一个文档博客之后,往往都是通过如下步骤来部署一篇博客:
村雨遥
2022/03/14
1.5K1
Vuepress + GitHub Actions 实现博客自动部署!
Apifox 接口文档设计和调试教程【工具篇】
Apifox 不是一个传统的测试工具,Apifox 更像是一个团队协作工具,围绕着接口开发文档,为我们规范了开发的整个流程。
码哥字节
2022/10/28
2.7K0
Apifox 接口文档设计和调试教程【工具篇】
12年经验的大龄程序员,你猜他用什么写API文档?
今天这次我们深度 “盘” 一下 Eolink 这款免费 API 协作平台,围绕【智能生成+盘活 API 资产】这一功能上,到底投入了多大的开发成本,给我们带来了多少惊喜!
梦想橡皮擦
2022/12/07
3880
12年经验的大龄程序员,你猜他用什么写API文档?
推荐阅读
相关推荐
超简单!Java 项目自动生成接口文档教程
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档