springboot 2.7.4 整合knife4j

Knife4j官网上的例子是基于SpringBoot 2.3.5 和 Knife4j 2.0.7 编写的。

按照官网写法，如果SpringBoot 版本是2.6以及以上就会报错。

SpringBoot 2.6 使用Spring Fox 接口统一api相关的文档接口，我们因此需要使用Knife4j 3.X 版本。

本文只使用了Knife4J的UI，文档框架直接使用Spring Fox

引入依赖

<groupId>com.github.xiaoymin</groupId>

<artifactId>knife4j-spring-ui</artifactId>

</dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-boot-starter</artifactId>

</dependency>

创建配置类

package com.luo.usercenter.config;

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.service.Contact;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

/**

* 自定义swagger接口文档的配置

* @author lkx

@Configuration

public class SwaggerConfig {

@Bean(value = "defaultApi2")

public Docket defaultApi2() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

// 分组名称

.groupName("用户中心")

.select()

//这里一定要标注你控制器的位置

.apis(RequestHandlerSelectors.basePackage("com.luo.usercenter.controller"))

.paths(PathSelectors.any())

.build();

}

/**

* api信息

* @return api对象信息

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("用户中心")

.description("用户中心接口文档")

.termsOfServiceUrl("https://github.com/manneia/")

.contact(new Contact("lkx","https://github.com/manneia/","luokaixuan2001@163.com"))

.version("1.0")

.build();

}

配置静态资源

package com.luo.usercenter;

import com.luo.usercenter.config.WebMvcConfig;

import org.mybatis.spring.annotation.MapperScan;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;

/**

* @author lkx

@SpringBootApplication

@EnableWebMvc

@MapperScan("com.luo.usercenter.mapper")

public class UserCenterApplication extends WebMvcConfig {

public static void main(String[] args) {

SpringApplication.run(UserCenterApplication.class, args);

}

@Override

public void addResourceHandlers(ResourceHandlerRegistry registry) {

registry.addResourceHandler("doc.html")

.addResourceLocations("classpath:/META-INF/resources/");

registry.addResourceHandler("/webjars/**")

.addResourceLocations("classpath:/META-INF/resources/webjars/");

}

引入依赖

创建配置类

配置静态资源

启动springboot项目 访问 localhost:IP/api/doc.html

启动springboot项目访问 localhost:IP/api/doc.html