【转】集成 swagger-bootstrap-ui后访问 页面404

时间:2025-03-20 07:07:33

SpringBoot访问页面404

默认情况下并不需要添加此配置即可访问

很多朋友在使用SpringBoot集成swagger-bootstrap-ui后,都无法访问界面,此时,你可能需要实现SpringBoot的WebMvcConfigurer接口,添加相关的ResourceHandler,代码如下:

@SpringBootApplication
public class SwaggerBootstrapUiDemoApplication  implements WebMvcConfigurer{

	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("/").addResourceLocations("classpath*:/META-INF/resources/");
		registry.addResourceHandler("/webjars/**").addResourceLocations("classpath*:/META-INF/resources/webjars/");
	}
}

或者

@SpringBootApplication
public class SwaggerBootstrapUiDemoApplication  implements WebMvcConfigurer{

	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("/").addResourceLocations("classpath:/META-INF/resources/");
		registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
	}
}

如果你是使用的老的版本SpringBoot,通过继承WebMvcConfigurationSupport来扩展SpringBoot相关的配置,则把以上配置加在相应的addResourceHandlers方法中即可

推荐使用实现WebMvcConfigurer接口的方式来进行扩展

如果以上方式还是不行,建议开启Spring的Debug日志来进行跟踪,一般访问 页面会出现如下日志(成功情况下):

2019-04-19 13:39:36,896 DEBUG (:312)- Looking up handler method for path /
2019-04-19 13:39:36,902 DEBUG (:322)- Did not find handler method for [/]
2019-04-19 13:39:36,921 DEBUG (:199)- Matching patterns for request [/] are [/**]
2019-04-19 13:39:36,922 DEBUG (:233)- URI Template variables for request [/] are {}
2019-04-19 13:39:36,923 DEBUG (:146)- Mapping [/] to HandlerExecutionChain with handler [ResourceHttpRequestHandler [locations=[class path resource [META-INF/resources/], class path resource [resources/], class path resource [static/], class path resource [public/], ServletContext resource [/]], resolvers=[@da32f3]]] and 1 interceptor
2019-04-19 13:39:36,957 DEBUG (:104)- Cleared thread-bound request context: @28759ea7
2019-04-19 13:39:41,649 DEBUG (:114)- Bound request context to thread: @28759ea7

SpringMvc 访问 页面404

SpringMvc中文档出现异常一般分2种情况:

  • 打开提示404
  • 已经可以打开,但是页面无任何接口文档

针对以上两种情况的解决办法:

第一种:打开提示404?

一般无需添加此配置,如果出现这种情况,在Spring的xml配置文件中,添加Spring的静态资源映射路径即可,如下:

<mvc:resources location="classpath:/META-INF/resources/" mapping=""/>
<mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>

第二种:已经可以打开,但是页面无任何接口文档?

中配置了DispatcherServlet,则需要追加一个url匹配规则,如下

<!-- 配置swagger-bootstrap-ui的url请求路径-->
<servlet-mapping>
    <servlet-name>swaggerDemoMvc</servlet-name>
    <url-pattern>/v2/api-docs</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>swaggerDemoMvc</servlet-name>
    <url-pattern>/swagger-resources</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>swaggerDemoMvc</servlet-name>
    <url-pattern>/swagger-resources/configuration/ui</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>swaggerDemoMvc</servlet-name>
    <url-pattern>/swagger-resources/configuration/security</url-pattern>
</servlet-mapping>
<!--此接口地址为SwaggerBootstrapUi提供的增强地址,如果不使用增强功能,可排除此配置-->
<servlet-mapping>
    <servlet-name>swaggerDemoMvc</servlet-name>
    <url-pattern>/v2/api-docs-ext</url-pattern>
</servlet-mapping>