SpringBoot2+Swagger2集成配置+问题请求不到swagger-ui.html解决方案

一、配置Maven

    
        UTF-8
        UTF-8
        1.8

        1.3.2
        2.4.2.1-RELEASE
        3.4
        1.10
        1.3.1
        1.0.5
        2.1.4
        1.2.41
        2.9.3
        1.1.9
        17.0
        2.3.0
        2.4.0
        true
        unnet
    
           
        
            org.springframework.boot
            spring-boot-starter-data-redis
        
        
        
            io.springfox
            springfox-swagger2
            ${swagger2.version}
        

        
            io.springfox
            springfox-swagger-ui
            ${swagger2.version}
        
        
    

二、配置详细信息

/**
 * Email: [email protected]
 * Copyright (c)  2019. missbe
 * @author lyg   19-5-30 下午8:35
 *
 *
 **/
@Configuration
@EnableSwagger2
public class Swagger2Config {
    /**
     * 添加摘要信息(Docket)
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.unnet.yjs.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Client Gateway-Swagger2 APIs")
                .termsOfServiceUrl("https://blog.csdn.net/lovequanquqn?viewmode=list")
                .contact(new Contact("unnet","https://blog.csdn.net/lovequanquqn?viewmode=list","[email protected]"))
                .version("1.0.0")
                .build();
    }
}

PS:Swagger2配置类需要和SpringBoot启动入口文件同一层

SpringBoot2+Swagger2集成配置+问题请求不到swagger-ui.html解决方案_第1张图片

三、SpringBoot集成Swagger2遇到异常:请求不到swagger-ui.html的问题

这个错误,是因为静态资源路径映射问题导致。
我们在访问http://localhost/swagger-ui.html时,这个swagger-ui.html相关的所有前端静态文件都在springfox-swagger-ui-2.4.0.jar里面。目录如下:

SpringBoot2+Swagger2集成配置+问题请求不到swagger-ui.html解决方案_第2张图片

SpringBoot自动配置本身并不会把/swagger-ui.html这个路径映射到对应的目录META-INF/resources/下面。我们加上这个映射即可。构建一个WebMvcConfig 类,代码如下:

@Configuration
public class WebMvcConfigurer extends WebMvcConfigurerAdapter {

    /**
     * 访问静态资源
     * */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        /**
         * SpringBoot自动配置本身并不会把/swagger-ui.html
         * 这个路径映射到对应的目录META-INF/resources/下面
         * 采用WebMvcConfigurerAdapter将swagger的静态文件进行发布;
         */
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
        //将所有/static/** 访问都映射到classpath:/static/ 目录下
        registry.addResourceHandler("/static/**").addResourceLocations(ResourceUtils.CLASSPATH_URL_PREFIX +"/static/");
        super.addResourceHandlers(registry);
    }
}

 

你可能感兴趣的:(java,maven,springboot)