Spring Boot项目中使用Knife4j 2.0.9打造专业级API文档手册
在当今前后端分离的开发模式下,API文档已经不再是简单的技术说明,而是连接开发团队的重要纽带。想象一下,当你的后端接口被前端、测试甚至产品经理频繁查阅时,一份清晰、完整且可交互的API文档能节省多少沟通成本?这就是为什么我们需要像Knife4j这样的工具——它能让你的API文档从"勉强能用"升级为"专业产品级"。
1. 环境准备与基础配置
1.1 依赖引入与版本选择
首先确保你的Spring Boot项目已经初始化完成。在pom.xml中添加以下依赖配置:
xml复制<properties>
<knife4j.version>2.0.9</knife4j.version>
</properties>
<dependencies>
<!-- Knife4j核心依赖 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>${knife4j.version}</version>
</dependency>
<!-- Spring Web基础依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
版本选择建议:
- 生产环境推荐使用2.0.x稳定版
- 需要Spring Boot 2.2.x及以上版本支持
- 与Swagger 2.9.x版本兼容性最佳
1.2 基础配置类详解
创建Swagger配置类SwaggerConfig.java:
java复制@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.your.pa
