当前位置：首页 > news >正文

【springboot集成knife4j】

news 2026/2/10 13:40:48

SpringBoot集成knife4j

Knife4j是为Java MVC框架集成Swagger生成API文档的一套增强解决方案，它基于Swagger原有的基础上进行了一些改进和增强，提供了更简洁的UI界面，同时支持更多的自用化配置。下面是在Spring Boot项目中集成Knife4j的基本步骤：

1. 引入依赖

首先，在你的pom.xml文件中添加Knife4j的相关依赖。确保你已经使用了Spring Boot的Web依赖。以下是基本的依赖示例：

<dependencies><!-- 其他依赖 --><!-- Knife4j Spring Boot Starter --><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>3.0.3</version> <!-- 请根据实际情况选择版本 --></dependency>
</dependencies>

注意：请检查是否有最新版本可用，并替换上述版本号。

2. 配置Swagger

接下来，你需要创建一个配置类来配置Swagger的基础信息，如应用名称、描述、版本等。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;@Configuration
public class SwaggerConfig {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()// 指定controller包路径.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("Spring Boot中使用Knife4j接口文档").description("更多关于SpringBoot相关文章请关注...").version("1.0").build();}
}

在这个配置类中，你可以通过.apis()方法指定要扫描生成API文档的Controller所在的基础包路径。

3. 访问API文档

完成上述步骤后，启动Spring Boot应用程序。然后在浏览器中访问http://localhost:8080/doc.html（默认情况下），你将看到Knife4j提供的UI界面，可以查看和测试你的API文档。

请注意，如果你的应用不是部署在根上下文路径下，或者你更改了默认的访问路径，请相应地调整URL。

这就是在Spring Boot项目中集成Knife4j的基本步骤。根据你的具体需求，可能还需要进行一些额外的配置或定制。

【springboot集成knife4j】