【问题标题】:How to exclude paths when using GroupedOpenAPI with SpringDoc将 GroupedOpenAPI 与 SpringDoc 一起使用时如何排除路径
【发布时间】:2020-05-21 06:33:17
【问题描述】:

我最近将 SpringFox 换成了 SpringDoc。

以前我可以像这样排除用于 Swagger UI 的路径:

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

在上述情况下,Swagger UI 将显示 path3 和 path5。

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

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

我希望有一个更通用的方式,我可以指定哪些路径不允许,所以如果我添加更多路径,默认情况下它们将被允许。比如:

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

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

【问题讨论】:

    标签: springdoc


    【解决方案1】:

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

    springdoc.paths-to-exclude= /test
    

    或者:

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

    【讨论】:

    • 太棒了!谢谢你。我看到此功能是 18 天前添加的 - 仅在我发布上述内容后 4 天。
    • 伟大的瑞克。你应该接受我猜的答案:)
    猜你喜欢
    • 1970-01-01
    • 2013-01-09
    • 1970-01-01
    • 2020-10-16
    • 2011-08-07
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2020-10-28
    相关资源
    最近更新 更多