SpringBoot使用Swagger接口文档(含分组配置)、Knife4j增强

最新推荐文章于 2026-04-05 02:59:39 发布

原创

最新推荐文章于 2026-04-05 02:59:39 发布 · 1.8k 阅读

标签

#spring boot #swagger #接口文档 #分组配置 #knife4j增强

收录于

本文介绍了如何在SpringBoot项目中集成Swagger，包括添加依赖、使用注解标记API，通过Docket进行分组配置，以及使用Knife4j增强Swagger功能。详细讲解了pom.xml配置、常用注解的使用和OpenAPI页面定制。

1. Swagger介绍

Swagger可以快速生成实时接口文档，方便前后开发人员进行协调沟通。遵循OpenAPI规范

2. OpenAPI 3架构

OpenAPI 3架构

3. 整合

3.1 pom.xml添加依赖

        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
            <version>2.1.0</version>
        </dependency>

默认访问http://localhost:8080/swagger-ui/index.html就可以打开接口文档的页面

3.2 常用注解

注解	标注位置	作用	示例
@Tag	controller类	标识controller作用	`@Tag(name = "登录",`

最低0.47元/天解锁文章

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

Bulut0907

关注关注

11
点赞
踩
8

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

Swagger--分组 & 接口注释

天行健君子以自强不息，地势坤君子以厚德载物。

06-06

6094

1. Swagger--分组和接口注释及小结 1.1 配置分组如果没有配置分组，默认是default。通过groupName()方法即可配置分组： groupName("group01") // 配置分组 SwaggerConfig.java /** * 配置docket以配置Swagger具体参数 */ @Bean public Docket docket(Environment environment) { return new Dock

参与评论您还未登录，请先登录后发表或查看评论

swagger knife4j 修改下拉框分组排序

qq_45472675的博客

03-07

1018

在使用knife4j的过程中项目为spring cloud alibaba微服务架构但在开发过程中有些服务非必须启动的服务但是进入knife4j管理页面过程中由于下拉框第0个位置的服务为非必须启动造成无法从页面选择其他服务。下拉框排序是根据router信息进行排序字母为字母排序加上数字会对数字进行排序但是swagger是获取predicates作为名称改掉yml predicates配置后前端路径还得修改。urls封装方法 sorted。

SpringBoot项目实战：Swagger3.0多模块分组配置全攻略（含代码示例）

最新发布

weixin_33734785的博客

04-05

359

本文详细介绍了SpringBoot项目中Swagger3.0的多模块分组配置方法，包括基础分组配置、高级分组技巧及企业级项目配置模板。通过代码示例展示了如何按业务模块划分API文档，提升开发协作效率，特别适合复杂企业级应用开发。

11-SpringBoot工程中整合Knife4j应用实践

雨田说码

04-24

3123

文章目录Knif4j简介概述设计目标Knif4j应用实践准备工作启动项目测试应用实践分析总结(Summary) Knif4j简介概述 knife4j是国人开发的一个基于Swagger2技术，为Java MVC框架生成Api文档的解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍! 设计目标为前后端的开发人员的沟通提供便利手段。 Knif4j应用实践准备工作第一步：在springboot项目的配置文件中添加，如下依赖： <!-

SpringBoot——SpringBoot生成接口文档

庄小焱

03-30

8023

SpringBoot开发Restful接口，有什么API规范吗？如何快速生成API文档呢？Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。本文主要介绍OpenAPI规范，以及Swagger技术栈基于OpenAPI规范的集成方案。

Spring Boot如何实现接口文档自动生成

it_xushixiong的博客

05-31

4112

Swagger是一种RESTful API文档生成工具，可以自动生成接口文档、API测试和客户端代码等。它通过注解方式标记API的信息，然后根据这些信息生成API的文档和测试页面。Swagger支持多种语言和框架，包括Java和Spring Boot。在本文中，我们将介绍如何使用Swagger实现Spring Boot接口文档自动生成。本文介绍了如何使用Swagger实现Spring Boot接口文档自动生成。我们首先添加了Swagger的依赖项，并在配置类中启用了Swagger。

SpringBoot Swagger集成终极指南：3步告别手动API文档时代 [特殊字符]

gitblog_00685的博客

03-27

928

还在为编写繁琐的API文档而烦恼吗？SpringBoot与Swagger的完美结合，让你彻底告别手动编写API文档的时代！这份完整的SpringBoot Swagger集成指南将为你展示如何快速搭建自动化的API文档系统，提升开发效率，让前后端协作更加顺畅。SpringBoot Swagger集成是现代化Java开发中不可或缺的一环，它通过自动生成API文档，极大地简化了开发流程。 [![Spr

SpringBoot集成Swagger2的增强版Knife4j

笑小枫

02-07

3335

Knife4j是一个集Swagger2 和 OpenAPI3 为一体的增强解决方案。增强扩展基础ui组件(自定义文档、动态参数调试、I18n、接口排序、导出等)基于Springfox框架+Swagger2规范的自动注入starter基于Springdoc-openapi+OAS3规范的自动注入starter提供对主流网关组件的统一聚合OpenAPI接口文档的解决方案。

swagger文档增强工具knife4j使用详解

热门推荐

baobao的博客

12-31

3万+

本文从本人博客搬运，原文格式更加美观，可以移步原文阅读：swagger文档增强工具knife4j使用详解使用原生的swagger作为接口文档，功能不够强大，并且默认的ui比较简陋，不符合大众审美。所以实际开发中推荐使用knife4j对swagger进行增强。knife4j的地址：https://gitee.com/xiaoym/knife4j 基本使用想要使用knife4j非常简单，只要在Springboot项目中引入knife4j的依赖即可 <dependency> <gro

Swagger的增强，knife4j的使用

qq_45632313的博客

11-18

1万+

Swagger作为一款API文档生成工具，虽然功能已经很完善了，但是还是有些不足的地方。偶然发现knife4j弥补了这些不足，赋予了Swagger更多的功能，今天我们来讲下它的使用方法。 knife4j简介 knife4j是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，提供了简洁、强大的接口文档体验。knife4j完全遵循了springfox-swagger中的使用方式，并在此基础上做了增强功能，如果你用过Swagger，你就可以无缝切换到knife4j。.

Knife4j—controller多包分组配置

helenbin14的博客

01-10

5391

注：我的一部分controller是在src/main/java/*/**/***/****/controller（路径1）下的不同包下，另一部分controller在src/main/java/*/**/***/generator（路径2）下，而且这2个部分的controller还有不同的子包，所以，我把路径1的所有controller路径放在一个Docket下，路径2的所有controller路径放在另一个Docket下，全部交给Spring管理，进行分组展示。2、Knife4j配置文件。

Swagger 接口分组

_修铁路的、的博客

03-17

9901

Swagger 默认只有一个 default 分组选项，如果没有设置，所有的接口都会显示在 default 分组下，如果功能模块和接口数量一多，就会显得有些凌乱，不方便查找和使用。为了解决这个问题，今天上午花了些时间查找Swagger 的接口分组设置办法，由于一开始思路和关键字设置不准备等原因，一时没找到正确满意的解决方案，直至看到大佬博客《swagger多个分...

SpringBoot整合knife4j(swagger)实现前后端分离可视化接口调试与接口测试

一恍过去

03-23

2万+

SpringBoot整合knife4j(swagger)实现前后端分离可视化接口调试与接口测试

springboot生成接口文档

weixin_58473601的博客

07-12

3450

springboot生成接口文档

knife4j、swagger、springdoc 返回接口分组排序问题

Stronger的博客

05-31

8892

解决knife4j返回接口分组排序问题

Spring Boot：Swagger生成接口文档并调试接口

安晴晚风的博客

08-01

4018

使用Swagger只需要按照它的规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面。

swagger接口文档分组

qq_41148693的博客

03-10

4074

swagger接口文档分组解析问题因项目中的接口越来越多，使用swagger调试接口的时候，因接口太杂太乱，不太容易找到想要调试的接口，所以研究了一下swagger分组的方法但是分组是需要配置多个Docket的bean，而一般配置，就是一个docket一个函数定义并加上@Bean注解，代码冗余太多，所以就想着用灵活的方式去配置swagger分组。 @Configuration public class SwaggerConfig { /** * 创建API */

Springboot集成Swagger实现接口文档自动生成

悠杨的专栏

11-25

1784

在实时接口文档的生成方案中，Swagger是最具影响力的一个。本文介绍了在Springboot项目中如何集成Swagger2和3，来实现接口文档的自动生成和更新的方法。

SpringBoot接口 - 如何生成接口文档之Swagger技术栈

jink104的博客

09-05

1258

OpenAPI 规范（OAS）定义了一个标准的、语言无关的 RESTful API 接口规范，它可以同时允许开发人员和操作系统查看并理解某个服务的功能，而无需访问源代码，文档或网络流量检查（既方便人类学习和阅读，也方便机器阅读）。正确定义 OAS 后，开发者可以使用最少的实现逻辑来理解远程服务并与之交互。此外，文档生成工具可以使用 OpenAPI 规范来生成 API 文档，代码生成工具可以生成各种编程语言下的服务端和客户端代码，测试代码和其他用例。

Swagger文档Knife4J文档Docket分栏分组优化，改为配置文件

qq_19480143的博客

01-26

1460

Swagger Knife4J Docket