swagger-ui 和 spring webflux 出现 404 错误

Posted 2023-02-27

【中文标题】swagger-ui 和 spring webflux 出现 404 错误

【英文标题】：404 error with swagger-ui and spring webflux

【发布时间】：2020-04-13 20:15:59

【问题描述】：

我正在使用 Spring Webflux 开发 REST 服务，并且我想使用 Swagger2 为我的 API 生成文档。我发现只有 Swagger2 版本 3.0.0 快照支持 Webflux。

这是我的配置：

java 11 maven 3

我的 SwaggerConfiguration bean 看起来像这样

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebFlux;

@Configuration
@EnableSwagger2WebFlux
public class SwaggerConfig 

    @Bean
    public Docket createRestApi() 
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .description("My Reactive API")
                        .title("My Domain object API")
                        .version("1.0.0")
                        .build())
                .enable(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.mypackage.service.myobject.controller"))
                .paths(PathSelectors.any())
                .build();

    

我的 springboot 应用是这样定义的：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.reactive.config.EnableWebFlux;

@SpringBootApplication
@EnableWebFlux
public class Application 
    public static void main(String[] args) 
        SpringApplication.run(Application.class, args);
    

这是我的 pom 配置

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.1.RELEASE</version>
</parent>

<properties>
    <swagger.version>3.0.0-SNAPSHOT</swagger.version>
</properties>

<dependencies>
    <dependency>
        <groupId>io.projectreactor</groupId>
        <artifactId>reactor-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.integration</groupId>
        <artifactId>spring-integration-webflux</artifactId>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>$swagger.version</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-spring-webflux</artifactId>
        <version>$swagger.version</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-spring-integration-webflux</artifactId>
        <version>$swagger.version</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>$swagger.version</version>
    </dependency>
</dependencies>

但是，当我在浏览器中输入 http://localhost:8080/swagger-ui.html 时，我收到 404 错误。 如果我输入http://localhost:8080/v2/api-docs，我会在 json 中为我的 API 获取 swagger 文档。

我在 Intellij 下调试我的 springboot 应用程序。我尝试在命令行中运行 fat jar：同样的问题。有人知道我的配置有什么问题吗？

谢谢

【参考方案1】：

找到了！

我必须像这样为 swagger-ui 注册一个 webflux 资源处理程序。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.config.ResourceHandlerRegistry;
import org.springframework.web.reactive.config.WebFluxConfigurer;

@Configuration
public class WebfluxConfig implements WebFluxConfigurer 

    @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/");
    

问题解决了！

【讨论】：

但对我来说它不起作用。收到 404 错误。