Swagger UI 过滤部分API

最新推荐文章于 2025-10-07 05:54:31 发布

原创最新推荐文章于 2025-10-07 05:54:31 发布 · 3.2k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#后端 #spring

java 专栏收录该内容

5 篇文章

订阅专栏

本文介绍如何通过修改Swagger配置，排除SwaggerUI前端展示中的特定API路径，以增强系统的安全性。通过自定义Predicate接口，可以灵活地指定需要排除的路径前缀。

有时候出于安全考虑，想要过滤Swagger UI前端展示的部分API。
此时仅需要修改swaggerConfig即可：

@EnableSwagger2
public class Swagger2Config {

    private static final List<String> excludedPathPrefix = Arrays.asList(
            "/path1",
            "/path2",
            "/path3"
    );

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.dfc.iomp.provider.controller"))
                .paths((s) -> {
                    for(String pathPrefix : excludedPathPrefix) {
                        if(StringUtils.startsWith(s, pathPrefix)) {
                            return false;
                        }
                    }
                    return true;
                })
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API说明文档")
                .version("1.0")
                .build();
    }

}

如上所示，在 createRestApi 方法中，声明paths时，需要传入一个 Predicate 的接口。
一般常规用法是直接传入 PathSelectors.any() 以匹配所有的路径。

实质上，仅需要传入一个 java.util.function.Predicate 的具体实现即可，这里用 lamba表示可以清晰表示，对每个URL做校验。

PS： 因为本例子用的校验方式是 startWith，所以声明需要被排除的路径时，必须以 / 开头。
PS2: 可以根据需要自定义 Predicate