快捷導(dǎo)航

SpringBoot基于knife4j生成接口文檔方式

更新時(shí)間：2026年05月30日 14:49:12 作者：半城喧囂、半城空

Knife4j介紹一個(gè)基于Swagger的JavaAPI文檔生成工具,提供美觀界面和高級(jí)功能,本文詳細(xì)介紹了在SpringBoot項(xiàng)目中集成Knife4j的方法,包括導(dǎo)入依賴、創(chuàng)建Swagger配置和WebMvcConfiguration配置類等

一、Knife4j介紹
二、在pom.xml中導(dǎo)入依賴
三、創(chuàng)建Swagger配置依賴，代碼如下
四、創(chuàng)建WebMvcConfiguration配置類，設(shè)置Knife4j生成的接口文檔靜態(tài)資源映射。
五、在controller接口中添加相應(yīng)的注解描述
六、啟動(dòng)項(xiàng)目，訪問
七、總結(jié)

一、Knife4j介紹

Knife4j是一個(gè)基于Swagger構(gòu)建的開源Java API文檔工具，它為Java開發(fā)者提供了生成、展示和調(diào)試API文檔的功能。

它提供了一套美觀且功能強(qiáng)大的界面，可以自動(dòng)生成API文檔，并支持接口分組、參數(shù)設(shè)置、請求示例、響應(yīng)模型配置等高級(jí)功能。

不同版本的SpringBoot項(xiàng)目需要不同版本的依賴，可去官方查看

二、在pom.xml中導(dǎo)入依賴

// SpringBoot2.1.8可使用如下版本
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.4</version>
</dependency>

三、創(chuàng)建Swagger配置依賴，代碼如下

//com.ztm.config.Knife4jConfiguration
// 如果后端接口分為用戶端和管理端，就在配置類中創(chuàng)建Docket1()和Docket2()

@Configuration
@EnableSwagger2  //根據(jù)依賴的版本不同可能是@EnableSwagger2或者@EnableSwagger2WebMvc
public class Knife4jConfiguration {
    @Bean
    public Docket Docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("SpringBoot2-Demo")
                .version("2.0")
                .description("SpringBoot2-Demo")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("xxx端接口")   //分組名稱
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.ztm.controller")) //這里指定Controller掃描包路徑
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

四、創(chuàng)建WebMvcConfiguration配置類，設(shè)置Knife4j生成的接口文檔靜態(tài)資源映射。

// com.ztm.config.WebMvcConfiguration
@Configuration
public class WebMvcConfiguration extends WebMvcConfigurationSupport {
    /**
     * 設(shè)置Knife4j接口文檔靜態(tài)資源映射
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}