前言

SpringBoot版本：2.7.8

一、引入依赖

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>

二、配置步骤

1. application.yaml配置

代码如下：

spring:
mvc:
pathmatch:
matching-strategy: ant_path_matcher

2. 创建配置类

代码如下：

package com.ms.product.config;
import com.ms.common.pojo.AdminToken;
import com.ms.common.pojo.UserToken;
import com.ms.product.entity.LoginAdminUser;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.ReflectionUtils;
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
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.spring.web.plugins.WebFluxRequestHandlerProvider;
import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;
import java.lang.reflect.Field;
import java.util.List;
import java.util.stream.Collectors;
@Configuration
public class ProductServiceSwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.enable(true)
.ignoredParameterTypes(AdminToken.class, LoginAdminUser.class, UserToken.class)
.select()
.apis(RequestHandlerSelectors.basePackage("com.ms.product.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("商品接口文档")
.description("swagger接口文档")
.version("1.0")
.build();
}
@Bean
public static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
return new BeanPostProcessor() {
@Override
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) {
customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
}
return bean;
}
private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) {
List<T> copy = mappings.stream()
.filter(mapping -> mapping.getPatternParser() == null)
.collect(Collectors.toList());
mappings.clear();
mappings.addAll(copy);
}
@SuppressWarnings("unchecked")
private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
try {
Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
field.setAccessible(true);
return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
} catch (IllegalArgumentException | IllegalAccessException e) {
throw new IllegalStateException(e);
}
}
};
}
}

三、 问题解决

在使用Knife4j时，出现：Failed to start bean 'documentationPluginsBootstrapper'报错

解决方法： 务必加入配置类中的springfoxHandlerProviderBeanPostProcessor方法

总结

• yaml文件中必须将匹配策略改为ant_path_matcher。
• 配置类中必须有springfoxHandlerProviderBeanPostProcessor方法。

最后

以上就是忧郁短靴为你收集整理的Springboot2.7整合Swagger3（Knife4j）前言一、引入依赖二、配置步骤三、 问题解决总结的全部内容，希望文章能够帮你解决Springboot2.7整合Swagger3（Knife4j）前言一、引入依赖二、配置步骤三、 问题解决总结所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。