springboot swagger配置,Unable to infer base url,攔截器問題
swagger配置很簡單,但是,因為使用到了攔截器,所以,就不簡單了,剛開始怎麼也不能顯示介面列表,後來才發現是攔截器的問題,然後就各種方法的試試。剛開始是配置webmvc的靜態資源類來過濾,但是後來發現還是不行。
後來仔細想想,配置了靜態資源過濾,但是攔截器與這個什麼webmvcconfigureadpter 是沒有關係的,雖然配置了,也還是會攔截。然後,就放棄了webmvc介面卡實現的方式,在攔截器裡面直接排除,然後就可以了。歷程如下。
1、引入swagger依賴 pom.xml 中
<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.7,我也不知道為啥試了其它的都不行。看看你們的嘍。
2、新增配置
@Configuration
@EnableSwagger2
public class Swagger2Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//加了ApiOperation註解的類,才生成介面文件
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
//包下的類,才生成介面文件
//.apis(RequestHandlerSelectors.basePackage("site.haiyang.cms.controller"))
.paths(PathSelectors.any())
.build();/*
.securitySchemes(security());*/
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot 測試使用 Swagger2 構建RESTful API")
.contact(new Contact("haiyangsite", "http://haiyang.site", ""))
.version("1.0")
.description("API 描述")
.build();
}
}
3、配置具體介面上的註解資料:
@RequestMapping("updateUser")
@ResponseBody
@ApiOperation(value = "修改使用者" , notes="更新使用者資訊")
@ApiImplicitParams({
@ApiImplicitParam(name = "phone", value = "手機號碼", required = true, paramType = "query", dataType = "String"),
@ApiImplicitParam(name = "nickName", value = "使用者暱稱", required = true, paramType = "query", dataType = "String")
})
public String update(HttpServletRequest request, String phone,String nickName)
4、重啟springboot服務,瀏覽器鍵入http://localhost:8080/swagger-ui.html 測試是否成功,如果顯示了你配置的api,就成功了。如果沒有顯示,就可能是被攔截了。我的就是。接下來說說我的遇到的問題及解決辦法。
5、為了測試,我讓攔截器始終返回true,然後,鍵入地址,奇蹟般的變化了,但是,仍然遇到了錯誤。。。頁面alert出了這個Unable to infer base url錯誤提示,然後就懷疑是不是swagger配置錯了,其實不是,還是攔截器的問題,因為我雖然返回了true,但是我的true裡還有response.writer 物件往頁面寫東西,這個是沒法改動的,所以,我就又想辦法,試著過濾掉靜態資原始檔,於是,進行了以下配置:
@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
registry.addResourceHandler("/swagger/**").addResourceLocations("classpath:/static/swagger/");
}
}
然後進行測試,還是不行,然後通過瀏覽器除錯,發現是一個swagger-resources路徑的被攔截了,我承認我這裡是沒有攔截,但是也懶得理會了。
6、最後,我直接在攔截器中統一過濾掉所有檔案,就好了:
registry.addInterceptor(getInterfaceAuthCheckInterceptor()).addPathPatterns("/**")
//這個是為了swagger做的過濾
.excludePathPatterns("/**/*.css", "/**/*.js", "/**/*.png", "/**/*.jpg", "/**/*.jpeg", "/*.html", "/**/*.html","/swagger-resources/**")
7、好了,現在可以看到介面列表了:
8、結語
naquanjie.com 一個免費領券的網站,ilujune,一個免費查券的微訊號機器人
http://static.music.haiyang.site/music.html 歡迎大家來聽歌喲(^U^)ノ~YO
如有任何疑問,請聯絡183942498 微信qq同號。謝謝您~