Swagger UI 在带有前缀路径的反向代理后不起作用

问题描述

我正在将 Apache 反向代理用于我的 spring 启动应用程序，并在启动应用程序中使用前缀路径（由代理设置）和上下文根。因此，我的应用程序的 url 是 https://<host-name>/<prefix-path>/<servlet-context-path>... 由于 Swagger 不知道那里的代理，因此我正在使用 spring 属性 server.forward-headers-strategy=framework 来处理 X-Forwarded-Prefix-Path 标头。但此属性正在替换 Swagger 配置 url 中的上下文根，即 swagger 配置的 url 变为 https://<host-name>/<prefix-path/...，它返回 404。此属性在没有 servlet 上下文路径的情况下也能工作。有没有办法让我们可以配置 swagger 来注册正确的 url？

解决方法

我认为您需要在 spring boot 配置中使用以下配置来进行 swagger

@Configuration
@Slf4j
public class SpringFoxConfig {
    @Value("${swagger.host}")
    private String swaggerHost

@Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .host(swaggerHost)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

其中 swaggerHost 指向您的特定应用程序路径。您需要在 application.properties 文件中指定它。

swagger.host=<host-name>/<prefix-path>/<servlet-context-path>