快捷導(dǎo)航

SpringBoot2.0集成Swagger2訪問(wèn)404的解決操作

更新時(shí)間：2020年09月29日 09:18:27 作者：xqnode

這篇文章主要介紹了SpringBoot2.0集成Swagger2訪問(wèn)404的解決操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧

最近使用最新的SpringBoot2.0集成Swagger2的時(shí)候遇到一個(gè)問(wèn)題，集成之后打開Swagger頁(yè)面的時(shí)候出現(xiàn)404，后臺(tái)提示找不到swagger-ui的頁(yè)面。

于是我看了下項(xiàng)目依賴swagger的結(jié)構(gòu)：

可以看到 swagger-ui.html 在META-INF/resources目錄下，所以我們需要手動(dòng)的將靜態(tài)資源路徑指向這里，在java中配置為：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
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.swagger2.annotations.EnableSwagger2;

/**
 * @author xiaqing
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {

  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.xqnode.controller"))
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("接口總覽")
        .description("測(cè)試")
        .version("1.0")
        .build();
  }

  /**
   * 防止@EnableMvc把默認(rèn)的靜態(tài)資源路徑覆蓋了，手動(dòng)設(shè)置的方式
   *
   * @param registry
   */
  @Override
  protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 解決靜態(tài)資源無(wú)法訪問(wèn)
    registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
    // 解決swagger無(wú)法訪問(wèn)
    registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
    // 解決swagger的js文件無(wú)法訪問(wèn)
    registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");

  }
}

在swagger的配置類中繼承WebMvcConfigurationSupport，實(shí)現(xiàn)addResourceHandlers方法，設(shè)置靜態(tài)資源可訪問(wèn)。

設(shè)置完成后重啟項(xiàng)目，就可以通過(guò) http://localhost:8080/swagger-ui.html 正常訪問(wèn)了。

===== 2019.03.13更新 =====

有的同學(xué)說(shuō)配置swagger后靜態(tài)資源目錄無(wú)法訪問(wèn)，我自己試了下，確實(shí)訪問(wèn)不了。原來(lái)的配置是：

@Override
  protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 解決swagger無(wú)法訪問(wèn)
    registry.addResourceHandler("/**").addResourceLocations("classpath:/META-INF/resources/").setCachePeriod(0);
  }

這里是將所有的請(qǐng)求都指向了META-INF/resources/目錄，顯然是不對(duì)的，會(huì)導(dǎo)致項(xiàng)目的其他靜態(tài)文件目錄無(wú)法正常訪問(wèn)，于是做了修改：

 @Override
  protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 解決靜態(tài)資源無(wú)法訪問(wèn)
    registry.addResourceHandler("/**")
        .addResourceLocations("classpath:/static/");
    // 解決swagger無(wú)法訪問(wèn)
    registry.addResourceHandler("/swagger-ui.html")
        .addResourceLocations("classpath:/META-INF/resources/");
    // 解決swagger的js文件無(wú)法訪問(wèn)
    registry.addResourceHandler("/webjars/**")
        .addResourceLocations("classpath:/META-INF/resources/webjars/");
  }

測(cè)試一下：

在resource的static文件夾下新建index.html