最近项目集成swagger2,结果本地swagger-ui.html可以打开,但是线上环境却无法打开。倒腾了一番终于解决问题,总结了以下几个解决方案:
1.@EnableWebMvc注解必须去掉!
2.请实现WebMvcConfigurer,并添加如下代码
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/swagger-ui.html");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
3.检查配置文件application.properties
- 将如下配置去掉,或者改成true:
spring.resources.add-mappings=false
- 将如下配置去掉:
spring.resources.static-locations: classpath:/webapp/
4.查看nginx配置(当前项目踩坑点)
检查前端代码,发现nginx配置有如下一段:
location /api/swagger-ui.html{
proxy_pass http://server-service:8080/;
proxy_set_header X-Real-IP $remote_addr;
client_max_body_size 1000m;
}
由于当前应用部署在k8s环境中,后端的api地址恰好为http://server-service:8080/,所以这个配置会导致请求直接转发到后端接口,导致无法访问页面。
事实上,针对swagger,前端nginx不需要做任何映射,直接请求 http:// {后端公网host}/swagger-ui.html 即可访问。