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 {
}

总结

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

相关文章

  • java原生序列化和Kryo序列化性能实例对比分析

    java原生序列化和Kryo序列化性能实例对比分析

    这篇文章主要介绍了java原生序列化和Kryo序列化性能实例对比分析,涉及Java和kryo序列化和反序列化相关实例,小编觉得很不错,这里分享给大家,希望给大家一个参考。
    2017-10-10
  • EntityWrapper如何在and条件中嵌套or语句

    EntityWrapper如何在and条件中嵌套or语句

    这篇文章主要介绍了EntityWrapper如何在and条件中嵌套or语句,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • java编写一个花名随机抽取器的实现示例

    java编写一个花名随机抽取器的实现示例

    这篇文章主要介绍了java编写一个花名随机抽取器的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-03-03
  • IDEA中springboot提示java:找不到符号符号:变量log问题

    IDEA中springboot提示java:找不到符号符号:变量log问题

    这篇文章主要介绍了IDEA中springboot提示java:找不到符号符号:变量log问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-04-04
  • Java中MapStruct映射处理器报错的问题解决

    Java中MapStruct映射处理器报错的问题解决

    MapStruct是一个强大的Java映射框架,它能够在编译时生成映射代码,,本文主要介绍了Java中MapStruct映射处理器报错的问题解决,具有一定的参考价值,感兴趣的可以了解一下
    2024-03-03
  • Java双向链表倒置功能实现过程解析

    Java双向链表倒置功能实现过程解析

    这篇文章主要介绍了Java双向链表倒置功能实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09
  • java适配器模式之万物拟人化

    java适配器模式之万物拟人化

    本文详细介绍了什么是适配器模式,适配器模式的种类以及各种类的详细讲解等,需要学习该知识点的小伙伴可以参考这篇文章
    2021-08-08
  • 浅谈Java基于Consul创建分布式锁

    浅谈Java基于Consul创建分布式锁

    这篇文章主要介绍了浅谈基于Consul创建分布式锁,Consul是HashiCorp公司推出的开源工具,用于实现分布式系统的服务发现与配置Consul是分布式的、高可用的、可横向扩展的,需要的朋友可以参考下
    2023-07-07
  • 如何在Eclipse中设置Oracle的JDBC

    如何在Eclipse中设置Oracle的JDBC

    以下是对在Eclipse中设置Oracle的JDBC的具体操作方法进行了详细的分析介绍,需要的朋友可以过来参考下
    2013-08-08
  • java操作excel导入导出的3种方式

    java操作excel导入导出的3种方式

    项目需要,要实现一个导入导出excel的功能,于是任务驱动着我学习到了POI、easypoi和easyexcel这3个java操作Excel的工具,下面这篇文章主要给大家介绍了关于java操作excel导入导出的3种方式,需要的朋友可以参考下
    2023-05-05

最新评论