springdoc - 在 SpringDoc 中使用 GroupedOpenAPI 时如何排除路径

标签 springdoc

我最近用 SpringDoc 取代了 SpringFox。

以前我能够排除用于 Swagger UI 的路径,如下所示:

new Docket(DocumentationType.SWAGGER_2).paths(Predicates.not(PathSelectors.regex("/path1/.*|/path2/.*|/path4/.*")))

在上述情况下,将为路径 3 和路径 5 显示 Swagger UI。

在使用 SpringDoc 时使用 GroupedOpenAPI,我只看到了一种显式设置应允许哪些路径的方法,例如

GroupedOpenApi.builder()
            .pathsToMatch("/path3/**", "/path5/**")

我希望有一种更通用的方法,我可以指定哪些路径不允许,所以如果我添加更多路径,默认情况下将允许它们。像这样的东西:

GroupedOpenApi.builder()
            .pathsToMatch("!/path1/**", "!/path2/**", "!/path4/**")

不确定是否支持类似的功能。任何帮助,将不胜感激。谢谢。

最佳答案

您可以使用以下属性来排除路径(使用 v1.2.32 测试)

springdoc.paths-to-exclude= /test

或者:

GroupedOpenApi.builder()
            .pathsToExclude("!/path1/**", "!/path2/**", "!/path4/**")

关于springdoc - 在 SpringDoc 中使用 GroupedOpenAPI 时如何排除路径,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/60074194/

相关文章:

java - 为什么 RouterFunctions.DefaultRouterFunction<T extends ServerResponse> 类中的谓词字段会获取 DefaultErrorWebExceptionHandler?

java - 如何使用 Java 中的泛型制定 OpenAPI 规范

springdoc - 我们可以在Springdoc中用redoc替换swagger-ui吗

swagger-2.0 - 从 springfox swagger2 迁移到 springdoc openapi

java - 在 springdoc-openapi-ui 中启用“授权”按钮以进行不记名 token 身份验证 (JWT)

openapi - springdoc 多个 404 响应使用@ApiResponse(java 注释)

spring-boot - 如何使用 springdoc for swagger open api 3.0 生成 Map<String, Object> 类型的 RequestBody?

java - OpenAPI 3 支持 Jersey

spring-boot - 使用 SpringDoc webflux 支持时无法显示 Swagger/OpenApi 文档

spring-boot - Spring-Doc open api 无法与 Spring cloud 配置服务器 @EnableConfigServer 一起使用