快捷導(dǎo)航

SpringBoot與knife4j的整合使用過程

更新時間：2024年08月12日 14:48:04 作者：小小李程序員

Knife4j?是一個基于Swagger構(gòu)建的開源?JavaAPI文檔工具,主要包括兩大核心功能:文檔說明和在線調(diào)試,這篇文章主要介紹了SpringBoot與knife4j的整合使用,需要的朋友可以參考下

版本

此處是 knife4j2.0.7 版本 SpringBoot2.3.5.RELEASE 版本

其他版本推薦

Spring Boot版本	Knife4j Swagger2規(guī)范
1.5.x ~ 2.0.0	<Knife4j 2.0.0
2.0 ~ 2.2	Knife4j 2.0.0 ~ 2.0.6
2.2.x~2.4.0	Knife4j 2.0.6 ~ 2.0.9
2.4.0~2.7.x	>=Knife4j 4.0.0
>= 3.0	>=Knife4j 4.0.0

導(dǎo)入maven坐標(biāo)

<!-- 導(dǎo)入knife4j2.0.7版本依賴  SpringBoot2.3.5.RELEASE 版本	-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-spring-boot-starter</artifactId>
   <version>2.0.7</version>
</dependency>

另外SpringBoot2.3.2.RELEASE ~ SpringBoot2.5.15版本與Knife4j2.0.7 ~ Knife4j3.0.3整合SpringBoot的起步依賴也是兼容的

編寫配置類

目錄結(jié)構(gòu)如下：

配置類：

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {
    // Student組的測試文檔
    @Bean(value = "studentDocket")
    public Docket studentDocket() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("測試學(xué)生端接口文檔")		// 設(shè)置當(dāng)前文檔的標(biāo)題
                        .description("用于測試學(xué)生端的所有接口的文檔")		//自定義文檔簡介
                        .termsOfServiceUrl("寫學(xué)生端人員的服務(wù)地址URL")	//寫這個模塊功能的程序員相關(guān)的URL
                        .contact("寫學(xué)生端人員的聯(lián)系方式(郵箱)")		//寫這個模塊功能的程序員的email郵箱
                        .version("1.0")	//指定當(dāng)前文檔的版本
                        .build())
                //分組名稱
                .groupName("學(xué)生端")		//設(shè)置當(dāng)前組名稱
                .select()
                //這里指定Controller掃描包路徑，"com.example.controller.student"是一個放Controller的包
                .apis(RequestHandlerSelectors.basePackage("com.example.controller.student"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
	// Teacher組的測試文檔
    @Bean(value = "teacherDocket")
    public Docket teacherDocket() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("測試教師端接口文檔")
                        .description("用于測試教師端的所有接口的文檔")
                        .termsOfServiceUrl("寫教師端人員的服務(wù)地址URL")
                        .contact("寫教師端人員的聯(lián)系方式(郵箱)")
                        .version("1.0")
                        .build())
                //分組名稱
                .groupName("教師端")
                .select()
                //這里指定Controller掃描包路徑
                .apis(RequestHandlerSelectors.basePackage("com.example.controller.teacher"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

StudentController學(xué)生控制層