springboot整合swagger3报Unable to infer base url错误问题

 更新时间:2024年05月22日 10:47:17   作者:天国的囚徒  
这篇文章主要介绍了springboot整合swagger3报Unable to infer base url错误问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

springboot整swagger3

工程中的pom文件加入依赖包

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

代码中配置Swagger3Config

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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * 说明:Swagger 接口API生成
 * 作者:wanghan
 */
@Configuration
@EnableOpenApi
public class Swagger3Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wanghan.ctrl"))    // 为当前包路径
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger3 RESTful API")    // 页面标题
                .version("3.0")                                // 版本号
                .description("接口文档")                    // 描述
                .build();
    }
}

Swagger 拦截配置

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 说明:Swagger 拦截配置
 * 作者:wanghan
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.
                addResourceHandler("/swagger-ui/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/")
                .resourceChain(false);
    }

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/swagger-ui/")
                .setViewName("forward:/swagger-ui/index.html");
    }
}

至此swagger已经配置到你的项目中了。

可以通过url访问了:

http://localhost:8080/swagger-ui/index.html

总是不那么顺利

然而在使用过程中,总是出现这个那个问题:

问题一:提示没有权限访问

如果你使用安全框架,Swagger3的内置接口就会访问受限,我们需要排除掉。

Spring Security是这么配置的:

@Override
public void configure(WebSecurity web) throws Exception {
    //忽略swagger3所需要用到的静态资源,允许访问
    web.ignoring().antMatchers( "/swagger-ui.html",
            "/swagger-ui/**",
            "/swagger-resources/**",
            "/v2/api-docs",
            "/v3/api-docs",
            "/webjars/**");
}

或者你使用的版本是Spring Security 5.4,你可以这么定制​​WebSecurity

@Bean
WebSecurityCustomizer swaggerWebSecurityCustomizer() {
    return (web) -> {
        web.ignoring().antMatchers(new String[]{"/swagger-ui.html", "/swagger-ui/**", "/swagger-resources/**", "/v2/api-docs", "/v3/api-docs", "/webjars/**"});
    };
}

问题二:报​​Unable to infer base url

你会发现Swagger3会报​​Unable to infer base url的错误,这是因为统一返回体影响到了Swagger3的一些内置接口。

解决方法是​​

@RestControllerAdvice​​​控制好生效的包范围,在你的实现类上加上basePackages = “项目包路径”

@ControllerAdvice(basePackages = "com.wanghan")
public class ApiResBodyAdvice implements ResponseBodyAdvice {
}

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • SpringBoot 整合Jest实例代码讲解

    SpringBoot 整合Jest实例代码讲解

    本文通过实例代码给大家介绍了SpringBoot 整合Jest的相关知识,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-08-08
  • 一文带你掌握java8中的reduce操作

    一文带你掌握java8中的reduce操作

    reduce 操作是一种通用的归约操作,它可以实现从 Stream 中生成一个值,其生成的值不是随意的,而是根据指定的计算模型,下面我们就来深入了解下java8中的reduce操作吧
    2023-12-12
  • 总结Java对象被序列化的两种方法

    总结Java对象被序列化的两种方法

    今天给大家带来的是关于Java的相关知识,文章围绕着Java对象被序列化的两种方法展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • java依赖jave-all-deps实现视频格式转换

    java依赖jave-all-deps实现视频格式转换

    jave-all-deps是一款基于FFmpeg库的Java音视频编解码库,本文主要介绍了java依赖jave-all-deps实现视频格式转换,具有一定的参考价值,感兴趣的可以了解一下
    2024-07-07
  • SpringBoot如何使用mica-xss防止Xss攻击

    SpringBoot如何使用mica-xss防止Xss攻击

    这篇文章主要介绍了SpringBoot如何使用mica-xss防止Xss攻击问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • Spring Boot Controller处理HTTP请求体的方法

    Spring Boot Controller处理HTTP请求体的方法

    Spring Boot提供了强大的机制来处理不同 Content-Type​ 的HTTP请求体,这主要依赖于 HttpMessageConverter​ 接口的各种实现,它们能够自动将请求体内容转换成Java方法参数,本文给大家介绍Spring Boot Controller处理HTTP请求体的方法,感兴趣的朋友一起看看吧
    2025-05-05
  • 手把手教你如何在Idea中下载jar包

    手把手教你如何在Idea中下载jar包

    maven依赖的jar包,很多时候同一个jar包会存在多个版本,删除其中一个后,重新编译,会把旧jar由加载回来了,下面这篇文章主要给大家介绍了关于如何在Idea中下载jar包的相关资料,需要的朋友可以参考下
    2023-06-06
  • Java并发编程之重入锁与读写锁

    Java并发编程之重入锁与读写锁

    这篇文章主要介绍了Java并发编程之重入锁与读写锁,文中相关实例代码详细,测试可用,具有一定参考价值,需要的朋友可以了解下。
    2017-09-09
  • 论java如何通过反射获得方法真实参数名及扩展研究

    论java如何通过反射获得方法真实参数名及扩展研究

    这篇文章主要为大家介绍了java如何通过反射获得方法的真实参数名以及扩展研究,有需要的朋友可以借鉴参考下,希望能够有所帮助祝大家多多进步早日升职加薪
    2022-01-01
  • 全网最精细详解二叉树,2万字带你进入算法领域

    全网最精细详解二叉树,2万字带你进入算法领域

    大家好,我是哪吒,一个热爱编码的Java工程师,本着"欲速则不达,欲达则欲速"的学习态度,在程序猿这条不归路上不断成长,所谓成长,不过是用时间慢慢擦亮你的眼睛,少时看重的,年长后却视若鸿毛,少时看轻的,年长后却视若泰山,成长之路,亦是渐渐放下执念,内心归于平静的旅程
    2021-08-08

最新评论