swagger 接口忽略/隐藏/不显示

Swagger是一个强大的开源框架，它可以帮助开发人员设计、构建、记录以及使用RESTful Web服务。在Swagger中，可以通过注解或配置来控制接口的显示情况，以隐藏或忽略某些不需要对外公开的接口。

1. **使用Swagger注解忽略接口**：
在Java的Spring框架中，可以使用`@ApiIgnore`注解来标记那些不需要在Swagger文档中展示的接口。例如：

   @ApiOperation(value = "私有方法", hidden = true)
   @RequestMapping(value = "/private", method = RequestMethod.GET)
   public String privateMethod() {
       return "This is a private method";
   }

在上面的例子中，`@ApiOperation`注解中的`hidden = true`属性会使得这个方法不在Swagger文档中显示。

2. **通过Swagger配置隐藏接口**：
在配置Swagger时，可以通过自定义Docket Bean来排除不需要展示的接口。例如：

   @Bean
   public Docket customImplementation() {
       return new Docket(DocumentationType.SWAGGER_2)
               .select()
               .apis(RequestHandlerSelectors.any())
               .paths(PathSelectors.any())
               .build()
               .ignoredParameterTypes(NonVisual.class) // 忽略特定参数类型
               .enableUrlTemplating(false); // 如果不使用URL模板，可以设置为false
   }

通过`ignoredParameterTypes`方法可以忽略掉带有特定注解的类作为参数的接口。

3. **全局配置隐藏接口**：
如果需要对所有接口进行全局的忽略设置，可以在`Docket`配置中使用`paths`方法来指定路径模式，然后排除掉不需要的路径模式：

   @Bean
   public Docket api() {
       return new Docket(DocumentationType.SWAGGER_2)
               .select()
               .apis(RequestHandlerSelectors.any())
               .paths(Predicates.not(PathSelectors.regex("/error.*"))) // 排除错误处理路径
               .build();
   }

在这个例子中，`Predicates.not(PathSelectors.regex("/error.*"))`表示忽略所有匹配`/error`路径的接口。