JApiDocs真香：以后再也不想用Swagger了

退休的汤姆

于 2021-07-03 20:34:23 发布

阅读量296

点赞数 1

CC 4.0 BY-SA版权

分类专栏： Java 文章标签： java spring vue spring boot

本文链接：https://blog.youkuaiyun.com/stone_tmp/article/details/118444754

本文介绍了如何使用JApiDocs工具，基于Controller上的Java注释，无需Swagger注解，即可生成接口文档。通过示例展示了配置、使用方法以及代码注释的添加，同时提供了高级用法，如自定义@ApiDoc和@Ignore注解。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1. 概述

Swagger最麻烦的就是需要在 Controller 上添加一堆 @ApiOperation、@ApiOperation 注解，对代码有一定的侵入性。今天，笔者推荐一个不需要加注解的解决方案。

抱大腿

这就是 JApiDocs ，它可以基于 Controller上的 Java 注释，直接生成接口文档。效果如下图所示：

JApiDocs真香：以后再也不想用Swagger了

效果图

友情提示GitHub 地址是：https://github.com/YeDaxia/JApiDocs 。

看完了 JApiDocs 生成的接口文档的效果，我们一起来快速入门下。完整的示例项目，可见 https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-24/lab-24-apidoc-japidocs 地址，代码如下图所示：

JApiDocs真香：以后再也不想用Swagger了

项目代码

下面，我们来瞅一瞅如何使用~

在 pom.xml 文件中，引入 japidocs 的依赖。

<dependency>
    <groupId>io.github.yedaxia</groupId>
    <artifactId>japidocs</artifactId>
    <version>1.4.4</version>
</dependency>

创建 TestJApiDocs 类，作为 JApiDocs 的配置，生成接口文档。代码如下：

public