Swagger OpenAPI 3.0 - Springdoc -分组的OpenApi在Spring MVC中不工作

bmvo0sr5 于 2022-11-14 发布在 Spring

关注(0)|答案(1)|浏览(402)

我的应用程序是Sping MVC，无法 Boot 。
我使用的是springdoc-openapi-ui 1.4.4
此外，我还将以下导入添加到了我的@configuration类之一;

org.springdoc.core.SpringDocConfigProperties.class, org.springdoc.core.SpringDocConfiguration.class, 
    org.springdoc.webmvc.core.SpringDocWebMvcConfiguration.class,
    org.springdoc.webmvc.core.MultipleOpenApiSupportConfiguration.class,
    org.springdoc.core.SwaggerUiConfigProperties.class, org.springdoc.core.SwaggerUiOAuthProperties.class,
    org.springdoc.webmvc.ui.SwaggerConfig.class, org.springdoc.core.CacheOrGroupedOpenApiCondition.class,
    org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration.class })

并按如下方式实现bean

@Bean
public GroupedOpenApi publicApi() {
    return GroupedOpenApi.builder()
            .group("user")
            .pathsToExclude("/api/v2/**", "/v2/**")
            .pathsToMatch("/api/v1/**", "/v1/**")
            .build();
}
@Bean
public GroupedOpenApi adminApi() {
    return GroupedOpenApi.builder()
            .group("admin")
            .pathsToExclude("/api/v1/**", "/v1/**")
            .pathsToMatch("/api/v2/**", "/v2/**")
            .build();
}

@Bean
public OpenAPI customOpenAPI() {
    return new OpenAPI()
        .components(new Components())
        .info(new Info()
            .title("titleI")
            .version("1.0.0"));
}

但当我尝试http://localhost:8080/MyApp/v3/api-docs/user时
给我404。
但我得到了http://localhost:8080/MyApp/v3/api-docs中列出的所有API
此外，还提供http://www.onlykalu.com:81/MyApp/swagger-ui/index.html?configUrl=/MyApp/v3/api-docs/swagger-config规格
也没有定义下拉。
如果我加上

springdoc.group-configs[0].group=user
springdoc.group-configs[1].group=admin

application.properties我就可以

我做错了什么？
我是否需要导入任何其他类才能使组功能正常工作？
谢谢

spring-mvc

来源：https://stackoverflow.com/questions/63627462/swagger-openapi-3-0-springdoc-groupedopenapi-not-working-in-spring-mvc

1条答案

按热度按时间

juzqafwq1#

您的问题也已在此处得到解答：

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

如前所述，您只需将Bean定义放在一个专用的配置类中，并将其添加到springdoc-openapi Bean导入中，以便相同的机制加载Bean。
以下是正确的Bean配置：

@Configuration
public class GroupsConfiguration {

    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder().group("user").pathsToExclude("/api/v2/**").pathsToMatch("/api/v1/**").build();
    }

    @Bean
    public GroupedOpenApi adminApi() {
        return GroupedOpenApi.builder().group("admin").pathsToExclude("/api/v1/**").pathsToMatch("/api/v2/**").build();
    }

    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI().components(new Components()).info(new Info().title("Spring MVC REST API")
                .contact(new Contact().name("Rasika Kaluwalgoda")).version("1.0.0"));
    }

}

并且springdoc-openapi连同组配置导入：

@Configuration
@Import({ org.springdoc.core.SpringDocConfigProperties.class,
        org.springdoc.webmvc.core.MultipleOpenApiSupportConfiguration.class,
        org.springdoc.core.SpringDocConfiguration.class, org.springdoc.webmvc.core.SpringDocWebMvcConfiguration.class,
        SwaggerUiConfigParameters.class, SwaggerUiOAuthProperties.class,
        org.springdoc.core.SwaggerUiConfigProperties.class, org.springdoc.core.SwaggerUiOAuthProperties.class,
        org.springdoc.webmvc.ui.SwaggerConfig.class, GroupsConfiguration.class,
        org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration.class })
public class SwaggerConfig {

}

赞(0）回复(0）举报 2022-11-14

我来回答

Swagger OpenAPI 3.0 - Springdoc -分组的OpenApi在Spring MVC中不工作

1条答案

相关问题

热门标签

最新问答