使用Apifox+idea插件+Javadoc彻底替代Java项目中的Swagger 实现代码零侵入（这里以SpringBoot多模块项目为例）

最新推荐文章于 2025-05-23 17:03:50 发布
最新推荐文章于 2025-05-23 17:03:50 发布
阅读量9.7k 收藏 8
点赞数 2
分类专栏： 工具方法文档 文章标签： intellij-idea java spring boot idea
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44606481/article/details/129096768
版权

使用Apifox+idea插件+Javadoc彻底替代Java项目中的Swagger 实现代码零侵入（这里以SpringBoot多模块项目为例）

前言

Swagger伴随了大部分Java工程师的整个接口文档生涯，个人觉得Swagger2使用起来是挺不错的就是代码侵入性太强功能没有现在的Apifox强大，Apifox中也可以直接导入Swagger的接口文档数据这种方式适合已有项目集成Apifox，新项目直接使用Apifox idea插件+Javadoc即可，完全实现代码无侵入.

前期准备

下载安装Apifox

官网下载

创建项目&获取项目ID

创建项目

在这里插入图片描述

获取项目ID

IDEA中要使用这个项目ID
在这里插入图片描述

生成个人API访问令牌

IDEA与Apixfox通讯时需要用到
在这里插入图片描述

IDEA安裝Apifox Helper插件

在这里插入图片描述
安装完成之后需要重启一下IDEA才能生效
在这里插入图片描述

实战使用

文档地址

创建一个测试项目

代码地址：https://gitee.com/kerwin_code/apifox-test2023.git
测试项目代码结构图
在这里插入图片描述

配置Apifox插件

不同版本的IDEA的Settings中ApifoxHelper可能在不同的目录下，如果不在根目录就点开后面几个多级菜单找一下，一般都在最后几个多级菜单中。
在这里插入图片描述

PS: 在模块项目ID配置中注意事项

  • 模块名称：可以填写任意层级的模块名称，Apifox会根据模块名称匹配，比如我这里是有二级模块填写的模块名称为apifox-order.
  • 目录名称：这个名称是用来控制Apifox控制台中的显示目录，如果不设置目录名称都是导入到根目录

编写SpringBoot测试代码

代码地址：https://gitee.com/kerwin_code/apifox-test2023.git
PS：这里不对部分代码细节做说明，可以直接下载代码自行查看。

同步接口到Apifox

每一次同步完成之后都需要刷新Apifox工具获取最新同步接口信息

同步整个模块接口到Apifox

在这里插入图片描述

同步 controller 文件内所有接口到Apifox

在这里插入图片描述

同步选择部分接口到Apifox

在这里插入图片描述
在这里插入图片描述

如何使用项目内配置文件.apifox-helper.properties

SpringCloud-Ribbon[入门案例]
02-24
它不像springcloud服务注册中心、配置中心、API网关那样独立部署，但是它几乎存在于每个springcloud微服务中。包括feign提供的声明式服务调用也是基于该Ribbon实现的。ribbon默认提供很多种负载均衡算法，例如轮询、...
springcloud-quickstart：基于gradle的spring cloud演示
02-04
springcloud-快速启动 这是一个基于层次的，构建工具的spring cloud微服务框架超级简单入门教程。spring cloud为开发人员提供了快速构建分布式系统的一种集成解决方案，包括配置管理，服务发现，断路器，路由，微...
SpringCloud - Gateway 网关
2201_75490194的博客
02-10 1131
Spring Cloud Gateway 是基于 Spring 生态系统（包括 Spring 6、Spring Boot 3 和 Project Reactor）构建的 API 网关。它旨在为 API 提供简单而有效的路由，并处理诸如安全性、监控/指标和弹性等跨领域关注点。
spring-cloud-gateway入门篇
BigBanana的博客
11-19 558
spring cloud gateway 快速入门。引入依赖，网关配置，启动测试
SpringCloud-Alibaba第二代微服务快速入门
现在的我强的可怕
09-29 2476
Spring Cloud Alibaba其实是阿里的微服务解决方案，是阿里巴巴结合自身微服务实践,开源的微服务全家桶，在Spring Cloud项目中孵化成为Spring Cloud的子项目。第一代的Spring Cloud标准中很多组件已经停更,如：Eureak,zuul等。所以Spring Cloud Alibaba很有可能成为Spring Cloud第二代的标准实现，所以许多组件在业界逐渐开始使用，已有很多成功案例。
Spring Cloud入门-Config分布式配置中心(Hoxton版本)
2501_90225587的博客
01-13 605
项目使用的Spring Cloud为Hoxton版本，Spring Boot为2.2.2.RELEASE版本Spring Cloud入门系列汇总| 序号 | 内容 | 链接地址 || 1 | Spring Cloud入门-十分钟了解Spring Cloud || 2 | Spring Cloud入门-Eureka服务注册与发现(Hoxton版本) || 3 | Spring Cloud入门-Ribbon服务消费者(Hoxton版本) |
Spring Cloud入门-Gateway服务网关(Hoxton版本)
2401_84094868的博客
05-03 1170
学习技术是一条慢长而艰苦的道路，不能靠一时激情，也不是熬几天几夜就能学好的，必须养成平时努力学习的习惯。所以：贵在坚持！最后再分享的一些BATJ等大厂20、21年的面试题，把这些技术点整理成了视频和PDF（实际上比预期多花了不少精力），包含知识脉络 + 诸多细节，由于篇幅有限，上面只是以图片的形式给大家展示一部分。Mybatis面试专题MySQL面试专题并发编程面试专题《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门，即可获取！cy>
spring cloud-skywalking入门指南
dzend的专栏
12-31 886
skywalking链路追踪入门指南
Spring Cloud Alibaba学习 1- NACOS入门使用
weixin_55797790的博客
02-25 1444
启动 nacos/bin/startup.cmd 时无法启动，右键编辑，将改成。
SpringCloud入门教程（全集）
热门推荐
tttalk的博客
03-01 9万+
SpringCloud所有常见组件介绍及使用示例
SpringCloud--gateway 网关
qq_55272229的博客
04-27 2558
springcloud中的网关组件
SpringCloud - Nacos详解
java123456111的博客
05-30 2万+
1、概述 服务发现是微服务架构体系中最关键的组件之一。如果尝试用手动的方式来给每一个客户端来配置所有服务提供者的服务列表是一件非常困难的事，而且也不利于服务的动态扩缩容。 Nacos Discovery 可以帮助您将服务自动注册到 Nacos 服务端并且能够动态感知和刷新某个服务实例的服务列表。 除此之外，Nacos Discovery 也将服务实例自身的一些元数据信息-例如 host，port, 健康检查URL，主页等内容注册到 Nacos。 2、注册中心原理 在使用注册中心时，一共有三种角色：服务提供者
springcloud-demo-master_spring-cloud_cloud_
10-04
【描述】"spring-cloud入门，大概流程为，以spring-boot为基础框架，搭建学习spring-cloud生态应用。" 这句话表明该项目旨在引导初学者了解Spring Cloud。首先，Spring Boot是一个简化Spring应用程序开发的框架，它...
spring-cloud项目_springcloud_springcloud项目_springcloud_spring-clou
10-03
这个项目包含了基本的 Spring Cloud 组件，非常适合新手入门学习。你可以通过这个项目了解如何集成和配置这些组件，以及它们如何协同工作来构建一个完整的微服务架构。在实际开发中，还需要考虑其他方面，如安全性、...
《springcloud&学习资料》--SpringCloud入门实例demo.zip
04-19
个人花大量时间整理出的实战资料，内容丰富，文档也很详细。无论做毕业设计还是用于学习技能，或工作中当做参考资料，都能发挥重要作用 亲们下载我任何一个付费资源后，即可私信联系我免费下载其他相关资源哦~ ...
Java 09Stream流与File类
asom12的博客
05-20 893
startWith(“张”)
初识C++：模版
2401_87194328的博客
05-23 444
该博客主要讲解模版的相关内容
canal实现mysql数据同步
最新发布
那些乐趣的博客
05-23 788
1、canal下载进入页面可以选择需要安装的版本下载canal.deployer-1.1.8.tar.gz和canal.admin-1.1.8.tar.gz2、mysql同步用户创建和授权在canal-admin解压文件的conf中有一个canal_manager.sql，导入到master数据库3、canal admin安装和启动把canal.admin-1.1.8.tar.gz上传到linux解压 tar -zvxf canal.admin-1.1.8.tar.gz。
Android 14 Binderized HAL开发实战指南（AIDL版）
Deep Lee的专栏
05-23 332
本文介绍了如何在Android 14中开发Binderized HAL服务，使用AIDL定义接口并实现HAL服务。首先，环境要求包括Android 14源码编译环境、AOSP android-14.0.0_r7分支、Soong构建系统、Java 17和NDK r25c。项目结构分为接口定义、实现层和SELinux策略。实现步骤包括定义AIDL接口、实现HAL服务、编写服务入口代码，并配置构建文件和SELinux策略。最后，通过VINTF配置确保服务在系统中可用，并提供了客户端调用示例。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值