错误的生成服务器url在springdoc-openapi-ui（Swagger UI）部署在代理

Question

带有springdoc openapi ui（Swagger ui）的SpringBoot2.2应用程序运行HTTP端口。应用程序部署到Kubernetes，入口将HTTPS请求从集群外部路由到服务。

在这种情况下，可在https://example.com/api/swagger-ui.html有错误的“生成的服务器url”-http://example.com/api。而它应该是https://example.com/api。

虽然Swagger UI是通过HTTPS访问的，但生成的服务器URL仍然使用HTTP。

Answer 1

springdoc-openapiFAQ有一节我如何在反向代理后面部署Doployspringdoc-openapi-ui？

常见问题部分可以扩展。

确保X-Forwarded标头由您的代理发送（X-Forwarded-For、X-Forwarded-Proto和其他）。

如果您正在使用下拖（spring boot starter Undertow），请设置属性server。forward headers strategy=NATIVE使Web服务器以本机方式处理X-Forwarded标头。此外，如果你不使用它，考虑切换到拖欠。

如果您使用的是Tomcat（spring boot starter Tomcat），请设置属性server。forward headers strategy=NATIVE，并确保列出属性服务器中要信任的所有内部代理的IP地址。公猫内部代理=192\\.168\\\\d{1,3}\\\\d{1,3}。默认情况下，10/8、192.168/16、169.254/16和127/8中的IP地址是可信的。

或者，对于Tomcat设置属性服务器。转发头策略=框架。

有用链接：

• 在前端代理服务器后面运行
• 自定义Tomcat的代理配置
• 服务器属性。转发标题策略

Answer 2

我也有同样的问题。下面是我的工作。

@OpenAPIDefinition( 
    servers = {
       @Server(url = "/", description = "Default Server URL")
    }
) 
@SpringBootApplication
public class App {
// ...
}

Answer 3

如果接受的解决方案不适合您，那么您可以通过定义bean来手动设置url。

@Bean
public OpenAPI customOpenAPI() {
    Server server = new Server();
    server.setUrl("https://example.com/api");
    return new OpenAPI().servers(List.of(server));
}

url可以通过一个属性定义并注入到这里。