Springdoc OpenAPI ui不支持“位置”中的上下文路径

Question

我使用的Java库springdoc-openapi-ui在版本1.4.0（通过Maven）没有任何定制在一个简单的Spring启动项目。

招摇过市页面是在下面生成的https://my-url.com/my-context-path/swagger-ui/index.html

以及api文档https://my-url.com/my-context-path/v3/api-docs/

这两种方法都有效，我可以找到它们。到现在为止，一直都还不错！

当简单地导航到https://my-url.com/my-context-path/swagger-ui.html我在响应头中得到一个HTTP状态302和一个location属性集，该属性应该将我从上面重定向到招摇过市页面（我假设）。

但是，位置属性中的URL错过了上下文路径！看起来像这样：https://my-url.com/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config

它重定向到一个不存在的页面，我得到一个404错误代码。请注意，configUrl似乎也缺少上下文路径。

你知道为什么会发生这种情况以及如何解决吗？

Github的这个问题似乎是同一个问题，但最后指出问题已经解决：https://github.com/springdoc/springdoc-openapi/issues/37这是我之前的版本。

Answer 1

没有关于上下文路径使用的已知问题。如你所能#37已经解决，报告已经证实了这一点！

只需确保遵循在标准Spring Boot应用程序上设置上下文路径的说明即可。

您可以在不同的演示示例中测试上下文路径的配置：

• https://github.com/springdoc/springdoc-openapi-demos

如果您有任何问题，可以通过提供最小/可复制的样本或通过再现问题的单元测试来记录问题。

Answer 2

好吧，问题是springdoc openapi ui不知道你的应用程序上下文路径，除非它是在springboot中定义的，这可能不是每个人都能做到的。

希望它确实支持非标准头X-Forwarded-Prefix，可由网关发送。

在我的情况下（库伯内特斯），入口可以通过简单地添加nginx.ingress.kubernetes.io/x-forwarded-prefix配置："true"

在您的应用程序配置中，您还需要指定

server:
  forward-headers-strategy: framework

使用Spring的支持来处理转发的头。

资料来源：

https://github.com/kubernetes/ingress-nginx/issues/3670

https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#x-转发前缀头

https://github.com/springdoc/springdoc-openapi/issues/607