带负载平衡器AWS上的OpenAPI Swagger配置

Question

我正在尝试在我的Spring Boot应用程序中添加Swagger（OpenApi），并以以下方式进行配置：

我的 pom.xml 文件具有以下依赖关系：

<!-- Swagger UI -->
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-ui</artifactId>
        <version>1.6.9</version>
    </dependency>

应用程序类具有 @springbootapplicationa 注释和以下bean定义：

/** Swagger Configuration */
@Bean
public OpenAPI seatManagerOpenAPI() {
    return new OpenAPI()
            .info(new Info().title("Service API")
                    .description("Some Description")
                    .version("0.0.1")
                    .license(new License().name("Apache 2.0").url("http://springdoc.org")))
            .externalDocs(new ExternalDocumentation()
                    .description("Some Documentation")
                    .url("https://somelink")
            );
}

我的Spring Boot应用程序具有一个控制器：

@RestController
@RequestMapping("/serviceName")
public class ServiceNameController

我的 application.yml

springdoc:
  packagesToScan: path.to.service
  pathsToMatch: /serviceName/**
  swagger-ui:
    path: /serviceName/swagger-ui

使用此非常基本的配置，Swagger在我的Localhost上正常工作：

[http：// localhost：8082/serviceName/swagger -ui/index.html]

但是，当部署到AWS上的ECS群集时，我的请求正在通过负载平衡器（ALB） - 我遇到以下错误：“失败：加载远程配置”。在浏览器中检查一下，我在日志中看到了404个状态，并有一条消息：

undefined /v3/api-docs/swagger-config

我有一个在EC上运行的几个微服务的群集。负载平衡器根据路径将各种HTTPS调用指向相关的目标组（服务），例如：

IF Path is /servicename/* AND Host is someHost
Then forward to [relevant target group] (service)

我看到了许多有关类似错误的帖子，并且与API Gateway的配置有关的答案（我根本不使用它在AWS上）或春季安全库（我根本不使用它）。

尝试添加此bean：

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

我还在应用程序中使用了许多配置。

springdoc:
#  swagger-ui:
#    use-root-path: false
#    url: "/v3/api-docs"
#    disable-swagger-default-url: true
#    path: /serviceName/swagger-ui
#    configUrl: "/swagger-config.yaml"
#    use-root-path: true
#    urls:
#      url: "/v3/api-docs"
#      name: "seat-manager"
#  api-docs:
#    enabled: true
#    path: /v3/api-docs/swagger-config

我 config.json 文件到我的资源和我的资源/静态文件夹，并来回更改内容，但我无法使其正常工作。

我在这里想念什么？哪种设置实际上会使Swagger在我的云中远程工作？

非常感谢您！

Answer 1

我遇到了同样的问题，解决方案是直接的。在ALB上，您还需要揭示Docu JSON页面，然后还需要播放API路径（用于呼叫）。

要简要介绍：要使Swagger在ALB上工作以下需要暴露：

1. /Swagger -ui* - ＆gt;访问Swagger Page
2. /v3 /api -docs* - ＆gt;需要以使Swagger Page加载
3. /API* - ＆gt;需要以使API调用工作