我有自己的RequestMappingHandlerMapping,我使用的是springfox-swagger-ui。添加我的自定义映射后,我无法在http://localhost:8080/swagger-ui.html获得swagger ui。 有什么想法吗?
这是我的配置。
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
@Override
@Bean
public RequestMappingHandlerMapping requestMappingHandlerMapping() {
return new ApiVersionRequestMappingHandlerMapping("v");
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry
.addResourceHandler("/webjars/**")
.addResourceLocations("(META-INF/resources/webjars");
}
}
这是我的pom.xml:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.hateoas</groupId>
<artifactId>spring-hateoas</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>javax.inject</groupId>
<artifactId>javax.inject</artifactId>
<version>1</version>
</dependency>
答案 0 :(得分:3)
当您覆盖WebMvcConfigurationSupport时,您还会覆盖spring Boot的mvc自动配置(WebMvcAutoConfiguration)。因此,需要spring boot配置的资源将无法运行。这不是swagger特有的问题。
您可以在此处找到有关此内容的更多信息:
https://github.com/spring-projects/spring-boot/issues/5004
正如github问题所表明的那样,将来会有更改,以使其更容易。目前有一些解决方法,正如那里所建议的那样。
快速而肮脏的方法是将WebMvcAutoConfiguration类复制并粘贴到您自己的类中,从EnableWebMvcConfiguration的requestMappingHandlerMapping()方法返回您自己的HandlerMapping,并将WebMvcAutoConfiguration的副本注册为自动配置类。你可以在这里看到说明:
确保将WebMvcAutoConfiguration的副本放在某个未扫描组件并自动拾取的包中。它应该按照上面的链接进行注册。
还要确保在从requestMappingHandlerMapping()方法返回之前将自定义HandlerMapping的顺序设置为0,如下所示:
@Bean
@Primary
@Override
public RequestMappingHandlerMapping requestMappingHandlerMapping() {
// Must be @Primary for MvcUriComponentsBuilder to work
ApiVersionRequestMappingHandlerMapping handlerMapping = new ApiVersionRequestMappingHandlerMapping("v");
handlerMapping.setOrder(0);
handlerMapping.setInterceptors(getInterceptors());
handlerMapping.setContentNegotiationManager(mvcContentNegotiationManager());
PathMatchConfigurer configurer = getPathMatchConfigurer();
if (configurer.isUseSuffixPatternMatch() != null) {
handlerMapping.setUseSuffixPatternMatch(configurer.isUseSuffixPatternMatch());
}
if (configurer.isUseRegisteredSuffixPatternMatch() != null) {
handlerMapping.setUseRegisteredSuffixPatternMatch(configurer.isUseRegisteredSuffixPatternMatch());
}
if (configurer.isUseTrailingSlashMatch() != null) {
handlerMapping.setUseTrailingSlashMatch(configurer.isUseTrailingSlashMatch());
}
if (configurer.getPathMatcher() != null) {
handlerMapping.setPathMatcher(configurer.getPathMatcher());
}
if (configurer.getUrlPathHelper() != null) {
handlerMapping.setUrlPathHelper(configurer.getUrlPathHelper());
}
return handlerMapping;
}
答案 1 :(得分:2)
覆盖requestMappingHandlerMapping()
的{{1}}将关闭弹簧启动的自动配置。要添加自定义MVC组件,您可以使用WebMvcRegistrations。例如,对于提供自定义WebMvcConfigurationSupport
,我们可以使用RequestMappingHandlerMapping
的自定义getRequestMappingHandlerMapping()
覆盖RequestMappingHandlerMapping
,并通过WebMvcRegistrationsAdapter
提供。如,
webMvcRegistrationsHandlerMapping()
答案 2 :(得分:1)
它对我有用。 覆盖addResourceHandlers而不是注册自动配置。
@Configuration
@EnableWebMvc
@EnableSwagger2
public class WebConfig 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/");
}
}
答案 3 :(得分:0)
在Spring Boot 2.0.0中,有一种更简单的方法可以实现此目的。
创建一个WebMvcRegistrations
接口实例作为Bean,并重写适当的方法以返回该对象的定制版本。 Spring Boot将读取并使用该实例。
在这种情况下,只需要覆盖getRequestMappingHandlerMapping()
并返回自定义实现
以上信息来自@Nazaret K提供的链接。 有关更多信息,请访问https://github.com/spring-projects/spring-boot/issues/5004
答案 4 :(得分:0)
可以通过使用WebMvcConfigurationSupport并为swagger添加资源处理程序来解决此问题:
@Configuration
public class MvcConfiguration extends WebMvcConfigurationSupport {
@Value("${spring.application.name}")
private String applicationName;
//...irrelevant code here
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
答案 5 :(得分:-2)
我终于找到了! 正确的配置是:
@Configuration
public class VersioningMappingHandlerConfig {
@Bean
public ApiVersionRequestMappingHandlerMapping customMappingHandlerMapping() {
ApiVersionRequestMappingHandlerMapping handler = new ApiVersionRequestMappingHandlerMapping("v", 1, 1);
handler.setOrder(-1);
return handler;
}
}
注意:没有extends WebMvcConfigurationSupport
,bean名称为customMappingHandlerMapping