關於springboot整合swagger問題及解決方法

Posted on by

一.前言

解決瞭一個困擾很久的問題。自己搭建的一個springboot項目，整合完jsp之後可以正常訪問前端界面，但當再整合上swagger之後，前端界面就無法訪問瞭。當註釋掉swagger之後，前端界面又可以正常訪問。

二.整合jsp

1.pom引入

<!-- 添加jsp引用 -->
<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-jasper</artifactId>
    <version>8.5.31</version>
</dependency>
<!--引入jquery包-->
<dependency>
     <groupId>org.webjars</groupId>
     <artifactId>jquery</artifactId>
     <version>3.3.1-2</version>
</dependency>

2.配置文件application.properties

#Spring boot視圖配置
#前綴
spring.mvc.view.prefix=/WEB-INF/
#後綴
spring.mvc.view.suffix=.jsp
#靜態文件訪問配置
spring.mvc.static-path-pattern=/static/**
spring.thymeleaf.cache=false

3.前端代碼目錄

4.運行效果

 三.整合swagger

1.pom引入

<!--swagger相關依賴-->
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <version>2.7.0</version>
</dependency>
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.7.0</version>
</dependency>

2.swagger配置文件

package com.xq.config;
 
import com.xq.common.constants.AppConstants;
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;
 
@Configuration
@EnableSwagger2
public class Swagger2Config extends WebMvcConfigurationSupport {
    //因為swagger與靜態文件訪問配置沖突，所以整合swagger需要
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        // springboot 集成swagger2.2後靜態資源404，添加如下兩行配置
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
        super.addResourceHandlers(registry);
    }
 
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("xq")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xq.yexiong.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(AppConstants.app+"的API接口")
                .version("1.0")
                .build();
    }
 
}

3.訪問swagger效果

4.訪問首頁

整合完swagger後，首頁無法訪問。註釋掉swagger配置文件後，又可以正常訪問首頁。報錯為：Could not resolve view with name ‘index’ in servlet with name ‘dispatcherServlet’。

查瞭很多，直到今日。

 四.解決辦法

在啟動類加如下代碼即可。加上該代碼後可以同時訪問首頁與swagger文檔。

  @Bean
    public InternalResourceViewResolver setupViewResolver(){
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix("/WEB-INF/");
        resolver.setSuffix(".jsp");
        return resolver;
    }

雖然解決瞭，但是依然不知造成jsp與swagger沖突的原因，有知道的大佬望請賜教！！！

到此這篇關於關於springboot整合swagger問題及解決方法的文章就介紹到這瞭,更多相關springboot整合swagger內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：

    None Found