Springdoc：打开 swagger-ui.html 时得到 404

Question

我有最新的 Spring Boot 应用程序和 springdoc.swagger-ui。

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>1.6.1</version>
</dependency>
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.2.32</version>
</dependency>

我的 application.properties 包含 springdoc.swagger-ui.path=/swagger-ui-openapi.html

当我通过 Intellij IDEA 运行应用程序时，http://localhost:8080/swagger-ui-openapi.html 将我带到http://localhost:8080/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config Swagger UI 页面加载成功。

但是，如果我通过命令行启动应用程序：“java -jar my-app.jar”，我在浏览器中得到 404，并且在尝试访问 http://localhost:8080/swagger-ui-openapi.html 时出现日志“圆形视图路径 [错误]”中的错误 它会将我重定向到http://localhost:8080/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config

javax.servlet.ServletException: Circular view path [error]: would dispatch back to the current handler URL [/error] again. Check your ViewResolver setup! (Hint: This may be the result of an unspecified view, due to default view name generation.)

但是，http://localhost:8080/v3/api-docs 是可访问的，并且架构在此地址可用。

我该如何解决这个问题？

Answer 1

对于这个问题，我的结论是： (1) 在IDEA中启动就可以了 (2) 使用 spring-boot-maven-plugin 重新打包 jar 并使用 'java -jar' 启动它也可以。 (3) 如果我尝试以 'java -classpath ".:.conf" DemoApplication' 开头，它不起作用。

所以，对于打包，我使用 spring-boot-maven-plugin。

Answer 2

当您的应用程序在代理、负载平衡器或云中运行时，在我的情况下什么是有效的。

在您的 Spring Boot 应用程序中，确保您的应用程序处理此标头：X-Forwarded-For。

有两种方法可以实现：

在你的属性文件中添加：

server.use-forward-headers=true

如果这还不够，Spring Framework 提供了一个 ForwardedHeaderFilter。您可以通过将 server.forward-headers-strategy 设置为 FRAMEWORK 将其注册为应用程序中的 Servlet 过滤器。

自 Spring Boot 2.2 起，这是处理反向代理标头的新属性：

在你的属性文件中添加

server.forward-headers-strategy=framework

您可以将以下 bean 添加到您的应用程序中：

@Bean
ForwardedHeaderFilter forwardedHeaderFilter() {
   return new ForwardedHeaderFilter();
}

如果你的根目录下已经有静态内容，并且你不希望它被 springdoc-openapi-ui 配置覆盖，你可以定义一个自定义配置 swagger-ui，以免覆盖从上下文根中配置文件：

例如在你的属性文件中使用：

springdoc.swagger-ui.path= /swagger-ui/api-docs.html

参考： https://springdoc.org/

Answer 3

springdoc-openapi 不需要 swagger-annotations v1.6.1 依赖；

默认情况下，使用 springdoc 您不需要任何 ViewResolver 的附加设置。

你可以看看一些示例代码：

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