Add support for MultipleOpenApiSupport when a Bean of type List<GroupedOpenApi> is present

[rajadilipkolli]

Is your feature request related to a problem? Please describe.

• I would like to create an aggregate Swagger API in the spring-cloud-gateway service using GroupedOpenAPI. To achieve this, I'm trying to trigger the definitions from RouteDefinitionLocator using below sample code

    @Bean
    List<GroupedOpenApi> groupedOpenApiList(RouteDefinitionLocator locator) {
        return locator.getRouteDefinitions()
                .filter(
                        routeDefinition ->
                                routeDefinition.getId().matches(".*-service"))
                .map(
                        routeDefinition -> {
                            String name =
                                    routeDefinition
                                            .getId()
                                            .replaceAll("-service", "");
                            return GroupedOpenApi.builder()
                                    .pathsToMatch("/" + name + "/**")
                                    .group(name)
                                    .build();
                        })
                .toStream()
                .toList();
    }

I expect MultipleOpenApiSupportConfiguration to trigger during the AutoConfiguration Scanning as spring boot application contains the Bean of type List<GroupedOpenApi>, however this is not triggered because of the failed condition @Conditional(MultipleOpenApiSupportCondition.class) . This is failing as MultipleOpenApiGroupsCondition.class only accepts a single GroupedOpenApi Bean or conditional property

Describe the solution you'd like

• Solution to make MultipleOpenApiGroupsCondition.java accept List<GroupedOpenApi> to make the conditional annotation become true

Describe alternatives you've considered

• Declaring the SpringBoot Main class with below package scanning is making is pass but this is wrong approach
  @SpringBootApplication(scanBasePackages = {"org.springdoc.webflux.api", "com.example.api.gateway"})

Additional context

• Below is the sample code used to demonstrate the idea
  demo.zip

[rajadilipkolli]

Thanks @bnasslahsen, when is this available for testing?

Should I be waiting till 2.0.0-RC2?

[bnasslahsen]

@rajadilipkolli,

I believe you have few workarounds.
I have reverted this change. Which is a breaking change when services are deployed outside of spring-cloud-gateway

[celcius112]

hello @bnasslahsen, I arrive a bit late but would it be possible that you elaborate on I believe you have few workarounds ? I have the same need as what was described in this issue, and the initial commit resolves it.

[rajadilipkolli]

Hi @celcius112 ,

Use below code for grouping as an alternative

    @Bean
    public List<GroupedOpenApi> groupedOpenApis(
            RouteDefinitionLocator locator, SwaggerUiConfigProperties swaggerUiConfigProperties) {
        Set<AbstractSwaggerUiConfigProperties.SwaggerUrl> swaggerUrls =
                swaggerUiConfigProperties.getUrls();
        return locator.getRouteDefinitions()
                .toStream()
                .map(RouteDefinition::getId)
                .filter(id -> id.endsWith("-service"))
                .map(
                        routeDefinitionId -> {
                            String name = extractNameFromRouteDefinitionId(routeDefinitionId);

                            swaggerUrls.add(
                                    new AbstractSwaggerUiConfigProperties.SwaggerUrl(
                                            name,
                                            "/" + routeDefinitionId + "/v3/api-docs",
                                            routeDefinitionId));
                            return GroupedOpenApi.builder()
                                    .pathsToMatch("/" + name + "/**")
                                    .group(name)
                                    .build();
                        })
                .toList();
    }

    private String extractNameFromRouteDefinitionId(String routeDefinitionId) {
        return routeDefinitionId.replace("-service", "");
    }

Sample can be found here