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

【Java学习】Knife4j使用流程

news 来源：原创 2025/4/21 16:11:27

手动添加依赖，并刷新Maven

<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-openapi2-spring-boot-starter</artifactId><version>4.3.0</version>
</dependency>

在配置文件application.properties中启用Knife4j

knife4j.enable=true

创建配置类config.Knife4jConfig.java
注意指定包扫描的路径：这将决定生成哪个包下的 API 文档，通常指定controller控制器所在的包

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;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {//配置Swagger2的Docket的Bean实例@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2)// apiInfo()：配置 API 的一些基本信息，比如：文档标题title，文档描述description，文档版本号version.apiInfo(apiInfo())// select()：生成 API 文档的选择器，用于指定要生成哪些 API 文档.select()// apis()：指定要生成哪个包下的 API 文档.apis(RequestHandlerSelectors.basePackage("你需要指定的包的路径"))// paths()：指定要生成哪个 URL 匹配模式下的 API 文档。这里使用 PathSelectors.any()，表示生成所有的 API 文档。.paths(PathSelectors.any()).build();}//文档信息配置private ApiInfo apiInfo() {return new ApiInfoBuilder()// 文档标题.title("项目名称")// 文档描述信息.description("XX项目在线API文档")// 文档版本号.version("X.0").build();}
}```4. 重启工程，浏览器访问（8080为常用接口号，根据配置文件application.properties内容的不同可能不同）> http://localhost:8080/doc.html