今天在个人springboot项目使用swagger时遇到页面始终空白的问题,就顺便贴个博文,简单写下springboot集成swagger,并记录下问题。
1. 引入依赖包
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<!--swagger ui依赖-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
2. 编写swagger配置类
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.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class Swagger {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.test.MyDemo.api"))//填写扫描Api接口的包
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("swagger文档标题")
.description("swagger文档注释")
.termsOfServiceUrl("服务地址")
.contact(new Contact("作者", "其它文档url", "邮箱"))
.version("1.0")
.build();
}
}
其实,到这一步已经可以启动应用打开swagger页面了。
http://localhost:80/swagger-ui.html#/ 记得将80更改成自己项目的端口
3. 给方法贴Api注解。这个自行百度,实在没有什么好说。
但是在启动后发现页面接口始终是空白的,如下图:
百度尝试了很多方法均无效,最后浏览器按F12看到部分请求资源被项目拦截器拦截了,拦截了,拦截,了!
下面是我的拦截器,拦截所有请求,所以把一个个需要忽略的资源都加进excludePathPatterns就OK了。
@Configuration
public class MvcConfig extends WebMvcConfigurerAdapter {
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(
new CheckLoginInterceptor())
.addPathPatterns("/*")
.excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");
}
public CheckLoginInterceptor checkLoginInterceptor(){
return new CheckLoginInterceptor();
}
}