13.9 SpringBoot集成Swagger2中遇到的问题

我们在使用SpringBoot集成Swagger2中,访问:​​http://127.0.0.1:8188/swagger-ui.html​

问题描述

可能出现两种错误:
1.页面显示默认报错页面。后台报错:

No handler found for GET /swagger-ui.html

2.显示Swagger空白页面:


13.9 SpringBoot集成Swagger2中遇到的问题_mvc



后台报错:

No mapping found for HTTP request with URI [/swagger-resources/configuration/ui] in DispatcherServlet with name 'dispatcherServlet'

解决方案

这个错误,是因为资源映射问题导致。
我们在访问​​​http://127.0.0.1:8188/swagger-ui.html​​ 时,这个swagger-ui.html相关的所有前端静态文件都在springfox-swagger-ui-2.6.1.jar里面。目录如下:


13.9 SpringBoot集成Swagger2中遇到的问题_html_02



Spring Boot自动配置本身不会自动把/swagger-ui.html这个路径映射到对应的目录META-INF/resources/下面。我们加上这个映射即可。代码如下:

@Configuration
class WebMvcConfig extends WebMvcConfigurerAdapter {
@Override
void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/")

registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/")
}


}

同时,在启动类上添加注解@EnableWebMvc。完整的Spring Boot集成Swagger2构建自动化Rest API文档工程示例,源码参考:

当然,为了更加方便使用SpringBoot集成swagger,这个工作可以直接通过定制swagger-starter来完成。