1
<!-- Knife4j 适配SpringBoot3 核心依赖 -->
2
<dependency>
3
<groupId>com.github.xiaoymin</groupId>
4
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
5
<version>4.4.0</version>
6
</dependency>

1
import org.springframework.context.annotation.Configuration;
2
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
3
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
4

5
/**
6
* SpringBoot3 静态资源放行配置
7
* 解决 doc.html 404 问题
8
*/
9
@Configuration
10
public class WebResourceConfig implements WebMvcConfigurer {
11

12
/**
13
* 放行Knife4j所有静态资源路径
14
*/
15
@Override
16
public void addResourceHandlers(ResourceHandlerRegistry registry) {
17
// 放行knife4j核心资源
18
registry.addResourceHandler("/doc.html")
19
.addResourceLocations("classpath:/META-INF/resources/");
20
registry.addResourceHandler("/webjars/**")
21
.addResourceLocations("classpath:/META-INF/resources/webjars/");
22
}

1
}

1
package com.hyxy.demo3.config;

1
import io.swagger.v3.oas.models.info.Contact;
2
import io.swagger.v3.oas.models.info.Info;
3
import io.swagger.v3.oas.models.OpenAPI;
4
import io.swagger.v3.oas.models.info.License;
5
import org.springframework.context.annotation.Bean;
6
import org.springframework.context.annotation.Configuration;
7

8
@Configuration
9
public class Knife4jOpenApiConfig {
10

11
/**
12
* 全局接口文档信息配置
13
*/
14
@Bean
15
public OpenAPI customOpenAPI() {
16
return new OpenAPI()
17
// 文档基础信息
18
.info(new Info()
19
.title("Xxx系统接口文档")
20
.version("3.0.0")
21
.description("基于SpringBoot3 + Knife4j4.5.0开发的标准化RESTful接口文档，支持在线调试、离线导出")
22
// 作者信息
23
.contact(new Contact()
24
.name("程序员")
25
.email("demo@163.com"))
26
// 开源协议
27
.license(new License()
28
.name("Apache 2.0")));
29
}

1
# 服务端口配置
2
server:
3
port: 8080
4

5
# Spring基础配置
6
spring:
7
application:
8
name: knife4j-springboot3-demo
9
# 关闭SpringBoot3默认异常页面，适配接口调试
10
mvc:

1
problemdetails:
2
enabled: true
3

4
# Knife4j 核心配置（SpringBoot3 通用）
5
knife4j:
6
# 开启增强模式（解锁全部高级功能，必开）
7
enable: true
8
# 生产环境开关（true=生产关闭文档，false=开发开启）
9
production: false
10
# UI个性化配置
11
setting:
12
# 开启暗黑模式
13
enable-dark-mode: true
14
# 开启接口搜索
15
enable-search: true
16
# 显示参数长度
17
enable-param-length: true
18
# 开启接口显示排序
19
enable-api-sort: true

1
统一访问地址：http://localhost:8080/doc.html

1
重启项目，访问 http://localhost:8080/doc.html，可实现：

1
package com.hyxy.demo3.config;

1
import io.swagger.v3.oas.models.Components;
2
import io.swagger.v3.oas.models.info.Contact;
3
import io.swagger.v3.oas.models.info.Info;
4
import io.swagger.v3.oas.models.OpenAPI;
5
import io.swagger.v3.oas.models.info.License;
6
import io.swagger.v3.oas.models.security.SecurityRequirement;
7
import io.swagger.v3.oas.models.security.SecurityScheme;
8
import org.springframework.context.annotation.Bean;

1
import org.springframework.context.annotation.Configuration;
2

3
@Configuration
4
public class Knife4jOpenApiConfig {
5
String securitySchemeName = "BearerToken";
6
/**
7
* 全局接口文档信息配置
8
*/
9
@Bean
10
public OpenAPI customOpenAPI() {
11
return new OpenAPI()
12
// 文档基础信息
13
.info(new Info()
14
.title("Xxx接口文档")
15
.version("3.0.0")
16
.description("基于SpringBoot3 + Knife4j4.5.0开发的标准化RESTful接口文档，支持在线调试、离线导出")
17
// 作者信息
18
.contact(new Contact()
19
.name("程序员")
20
.email("demo@163.com"))
21
// 开源协议
22
.license(new License()
23
.name("Apache 2.0")))
24
// ==========全局Token配置核心代码==========
25
.components(new Components()
26
.addSecuritySchemes(securitySchemeName,
27
new SecurityScheme()
28
// 类型：http认证
29
.type(SecurityScheme.Type.HTTP)
30
// bearer代表JWT
31
.scheme("bearer")
32
.bearerFormat("JWT")
33
.description("请输入Token，格式：Bearer 你的token值")
34
)
35
)
36
// 将安全方案应用到全部接口
37
.addSecurityItem(new SecurityRequirement().addList(securitySchemeName));
38
}
39

40
}

1
import io.swagger.v3.oas.annotations.Hidden;
2
import org.springframework.web.bind.annotation.PostMapping;
3
import org.springframework.web.bind.annotation.RequestMapping;
4
import org.springframework.web.bind.annotation.RestController;
5

6
// 隐藏整个控制器所有接口
7
@Hidden
8
@RestController
9
@RequestMapping("/admin")
10
public class AdminController {
11

12
// 隐藏单个敏感接口
13
@Hidden
14
@PostMapping("/updatePwd")
15
public String updatePwd() {
16
return "密码修改成功";
17
}
18
}

1
knife4j:
2
enable: true
3
production: false

1
knife4j:
2
enable: false
3
production: true

1
knife4j:
2
enable: true
3
production: false
4
basic:
5
enable: true
6
username: admin
7
password: 123456