SpringBoot整合Knife4j实现接口文档自动生成的最佳实践
写接口文档有多烦人？做过前后端联调的朋友都懂。手写吧，费时费力还容易跟代码对不上号；不写吧，前端同事跑来问接口参数，一天能打断你八回。Knife4j 这玩意儿就是来终结这种痛苦的——只要加几个注解，接口文档自动生成，还附带在线调试功能。 一、为什么选 Knife4j 目前市面上做接口文档的方案不少，
写接口文档有多烦人？做过前后端联调的朋友都懂。手写吧，费时费力还容易跟代码对不上号；不写吧，前端同事跑来问接口参数，一天能打断你八回。Knife4j 这玩意儿就是来终结这种痛苦的——只要加几个注解，接口文档自动生成，还附带在线调试功能。
一、为什么选 Knife4j
目前市面上做接口文档的方案不少，但从实际体验来看，Knife4j 对国内开发者确实很友好。核心优势在于两点：一是 UI 界面做了汉化，看着舒服；二是它不仅仅是文档展示工具，在线调试功能体验比原生的 Swagger UI 更流畅。
拿它和 Swagger UI、手写文档对比一下，差别就很直观了：Knife4j 的支持度更完善，Swagger UI 虽然也能在线调试，但界面是英文的，手写文档就更不用说了，维护成本高到离谱。代码上，Knife4j 和 Swagger 都是走注解方式，侵入性很低，但 Knife4j 的维护成本几乎为零——因为文档跟代码是自动同步的。
二、集成 Knife4j
1. 引入依赖
将下面这个依赖加到 pom.xml 里，版本号建议用稳定版：
com.github.xiaoymin knife4j-spring-boot-starter 3.0.3
2. 配置
然后在 application.yml 或 application.properties 里补充这几项配置，确保 Spring 的路径匹配方式兼容 Knife4j：
spring:
mvc:
pathmatch:
matching-strategy: ant_path_matcher
knife4j:
enable: true
setting:
language: zh-CN
enable-swagger-models: true
enable-document-manage: true
swagger-model-order: 1
3. 配置类
创建一个配置类，注册一个 Docket Bean。这里的关键是指定好你想扫描的控制器包路径，比如下面这个例子扫的是 com.zhang 包下的所有控制器：
@Configuration
@EnableKnife4j
public class Knife4jConfig {
@Bean
public Docket defaultApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.zhang"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("秒杀系统接口文档")
.description("电商秒杀系统 RESTful API")
.version("V1.0")
.contact(new Contact("张政", "", ""))
.build();
}
}
做完上面这三步，项目启动后访问 http://localhost:9090/doc.html，就能看到自动生成的接口文档页面了。页面里不光能看到每个接口的请求方式、参数说明、返回示例，还能直接点「调试」按钮在线测试接口，省去了来回切换工具的痛苦。
正软商城本月促销专区，汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动，提供限时折扣、特价授权和优惠购买信息，活动库存及价格以页面实时展示为准。
正软商城装机必备专区，精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件，帮助用户快速完成新电脑软件配置。
正软商城Windows软件专区，汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件，提供软件介绍、系统要求、正版授权及购买下载服务。
正软商城macOS软件专区，精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具，提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。
正软商城iOS软件专区，精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用，提供功能介绍、适用设备、系统要求和正版获取方式等信息。
正软商城AI软件专区，汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具，提供功能介绍、适用平台、收费方式及正版购买信息。
正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法，同时介绍常用PDF软件和工具的使用技巧。
赤友清理大师是一款为 Mac 设计的智能清理优化工具，可精准扫描垃圾、大文件、重复文件等，释放磁盘空间。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
极度公式是一款跨平台专业LaTeX公式识别编辑软件，支持OCR公式识别和多平台编辑。和使用说明，避免使用，享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
一款文字处理软件，一种订阅式的跨平台办公软件，基于云平台提供多种服务，通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合，Office 365 可让任何人使用任何设备随时随地创建和共享内容。
CodeExpander 是一款快捷短语输入增强工具，通过键入缩写自动展开为自定义文段，提升工作效率。任务管理和过程控制会更完整，持续下载、批量同步或需要稳定传输流程的场景会更适合它。
Mountain Duck 是一款能将多个网盘挂载到本地的工具，像本地磁盘一样使用网盘。清理链路的完整性会更好一些，做应用卸载、残留处理和空间整理时，通常能少走很多手动排查步骤。
极度公式是一款跨平台专业LaTeX公式识别编辑软件，支持OCR公式识别和多平台编辑。和使用说明，避免使用，享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
一款文字处理软件，一种订阅式的跨平台办公软件，基于云平台提供多种服务，通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合，Office 365 可让任何人使用任何设备随时随地创建和共享内容。
Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件，为私密数据添加多重保护。高频操作更强调就近处理，浏览、整理和跨目录移动文件时，来回切换和重复点击都会少很多。
CodeExpander 是一款快捷短语输入增强工具，通过键入缩写自动展开为自定义文段，提升工作效率。任务管理和过程控制会更完整，持续下载、批量同步或需要稳定传输流程的场景会更适合它。
Mountain Duck 是一款能将多个网盘挂载到本地的工具，像本地磁盘一样使用网盘。清理链路的完整性会更好一些，做应用卸载、残留处理和空间整理时，通常能少走很多手动排查步骤。
