nginx 代理背后的 SpringDoc/Swagger

Question

我们在 nginx 代理后面运行服务，以便：

http://service-post:8080/swagger-ui.html 被路由到公共地址https://host.com/services/post/swagger-ui.html

或者换个说法：

当 nginx 收到https://host.com/services/post/swagger-ui.html 上的请求时，它会剥离/services/post/ 前缀并将请求传递给/swagger-ui.html 路径上的post 服务。

在设置任何东西（使用默认 SpringDoc 配置）之前，我可以正确地看到 http://service-post:8080/swagger-ui.html 上的 swagger 文档。

为了在 host.com 上设置公共地址的路径，我使用的是：

springdoc.api-docs.path:        /services/post/api-docs
springdoc.swagger-ui.path:      /services/post/swagger-ui.html
springdoc.swagger-ui.configUrl: /services/post/v3/api-docs/swagger-config

然而，这似乎完全阻止了它：

/swagger-ui.html、/api-docs 和 /v3/api-docs/swagger-config 均返回 404 service-post:8080/* 和 https://host.com/services/post/*

似乎唯一有效的是https://host.com/services/post/swagger-ui/index.html，它显示了宠物商店的文档。

我们没有使用 Spring Boot，只是版本 5.3.1 的 Spring MVC。

那么我该如何设置以保持对原始路径（例如/api-docs）的处理，但在前缀路径（/services/post/api-docs）上执行查找？

Answer 1

这里都有记录：

• https://springdoc.org/index.html#how-can-i-deploy-springdoc-openapi-ui-behind-a-reverse-proxy

如果你没有使用spring-boot，你可以添加ForwardedHeaderFilter bean：

• https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/filter/ForwardedHeaderFilter.html

Answer 2

最后我完全忽略了默认重定向：

• swagger-ui.html -> `swagger-ui/index.html?url=/v3/api-docs

并实现了我自己的：

• docs -> swagger-ui/index.html?url=MY_PREFIX/v3/api-docs

这样我不需要更改任何东西，一切都使用默认设置。