快捷導(dǎo)航

SpringBoot整合Knife4j的實(shí)戰(zhàn)示例

更新時(shí)間：2025年08月26日 11:44:21 作者：阿黃學(xué)技術(shù)

Knife4j是一個(gè)為Java MVC框架集成Swagger生成API文檔的增強(qiáng)解決方案,本文就來介紹一下SpringBoot整合Knife4j的實(shí)戰(zhàn)示例,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

一，Knife4J介紹

Knife4j 是一個(gè)為 Java MVC 框架集成 Swagger 生成 API 文檔的增強(qiáng)解決方案，前身是 Swagger-Bootstrap-UI。相比于Swagger，Knife4j提供了更美觀、現(xiàn)代化的 UI 界面，增強(qiáng)了交互性。

二，Knife4J和SpringBoot版本關(guān)系

三，整合步驟

1. 配置環(huán)境

JDK：17
SpringBoot：3.4.5
Knife4j：4.5.0

2. 引入依賴

<dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
      <version>4.5.0</version>
</dependency>

3. 添加配置信息

在application.yml里面添加配置

# springdoc-openapi項(xiàng)目配置
springdoc:
  swagger-ui:
    #自定義swagger前端請(qǐng)求路徑,輸入http:localhost:8080/swagger-ui會(huì)自動(dòng)重定向到swagger頁面
    path: /swagger-ui
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs  #swagger后端請(qǐng)求地址
    enabled: true   #是否開啟文檔功能
  group-configs: #分組配置,可配置多個(gè)分組
    - group: 'default'             #分組名稱
      paths-to-match: '/**'        #配置需要匹配的路徑
      packages-to-scan: com.cms    #配置要掃描包的路徑,一般配置到啟動(dòng)類所在的包名
    - group: 'admin-api'
      paths-to-match: '/**'
      packages-to-scan: com.cms

4. 定義配置類

WebMvcConfig配置SpringMVC信息

/**
 * web層配置類,實(shí)現(xiàn)靜態(tài)資源映射，將knife4j相關(guān)資源放行，保證生成的接口文檔能夠正常進(jìn)行展示
 * @author Hva
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
 
    /**
     * 設(shè)置靜態(tài)資源映射
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 添加靜態(tài)資源映射規(guī)則
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
        //配置 knife4j 的靜態(tài)資源請(qǐng)求映射地址
        registry.addResourceHandler("/doc.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

配置Knife4j配置信息

/**
 * Knife4j整合Swagger3 Api接口文檔配置類
 * @author Hva
 */
@Configuration
public class Knife4jConfig {
 
    /**
     * 創(chuàng)建了一個(gè)api接口的分組
     * 除了配置文件方式創(chuàng)建分組，也可以通過注冊(cè)bean創(chuàng)建分組
     */
    @Bean
    public GroupedOpenApi adminApi() { 
        return GroupedOpenApi.builder()
                // 分組名稱
                .group("app-api")
                // 接口請(qǐng)求路徑規(guī)則
                .pathsToMatch("/**")
                .build();
    }
 
    /**
     * 配置基本信息
     */
    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI()
                .info(new Info()
                        // 標(biāo)題
                        .title("Knife4j整合Swagger3 Api接口文檔")
                        // 描述Api接口文檔的基本信息
                        .description("Knife4j后端接口服務(wù)...")
                        // 版本
                        .version("v1.0.0")
                        // 設(shè)置OpenAPI文檔的聯(lián)系信息，姓名，郵箱。
                        .contact(new Contact().name("Hva").email("Hva@163.com"))
                        // 設(shè)置OpenAPI文檔的許可證信息，包括許可證名稱為"Apache 2.0"，許可證URL為"http://springdoc.org"。
                        .license(new License().name("Apache 2.0").url("http://springdoc.org"))
                );
    }
}

5. 創(chuàng)建測(cè)試類Controller

DemoController

@RestController
@RequestMapping("demo")
public class DemoController {

    @GetMapping("test")
    @Operation(summary = "測(cè)試問好", description = "測(cè)試問好")
    @Tag(name = "問好", description = "問好")
    public String demo() {
        return "Hello Knife4j";
    }

}