Knife4j 4.x 完整使用指南（Spring Boot 3 适配版）

张开发
• 2026/4/10 14:58:31 • 15 分钟阅读

最新文章

推荐文章

相关文章

分享文章

Knife4j 4.x 完整使用指南（Spring Boot 3 适配版）
一、核心概述Knife4j 是基于SpringDoc（OpenAPI 3 规范）的增强版接口文档工具，完美适配 Spring Boot 3，在 Swagger 原生功能基础上做了 UI 美化、功能增强，是企业级项目接口文档的主流选择。二、环境准备（依赖引入）1. Maven 依赖（Spring Boot 3 + Knife4j 4.x 标准）在 pom.xmldependency groupIdcom.github.xiaoymin/groupId artifactIdknife4j-openapi3-jakarta-spring-boot-starter/artifactId version4.5.0/version /dependency说明：Knife4j 4.x 已内置 SpringDoc 依赖（Swagger 与 Spring Boot 3 的集成库），无需额外引入 springdoc-openapi 依赖。三、application.yml 完整配置1. 基础增强配置# Knife4j 核心增强配置 knife4j: # 开启增强模式（默认false，必须开启才能使用Knife4j增强功能） enable: true # 生产环境安全配置：开启后屏蔽所有文档资源，避免接口泄露 production: false # HTTP 基础认证（可选，给文档加访问密码） basic: enable: false username: laoli password: 123456 # 个性化UI设置（可选） setting: # UI默认语言：中文ZH_CN / 英文EN language: ZH_CN # 开启自定义Footer enable-footer-custom: true # 自定义Footer内容 footer-custom-content: 莲城的老李 # Swagger模型列表名称 swagger-model-name: 实体类列表 # 显示服务分组（默认true） enable-group: true # 关闭搜索功能（默认true，可按需关闭） enable-search: false # SpringDoc 原生配置（API文档分组，Knife4j完美支持） springdoc: # API文档分组配置（Swagger原生功能，非Knife4j特有） group-configs: - group: 'departments' # 匹配部门相关接口 paths-to-match: '/api/departments/**' - group: 'employees' # 匹配员工相关接口 paths-to-match: '/api/employees/**'2. 生产环境安全配置（必看）

更多文章