Spring Boot中Swagger 3.0如何移除变量？@ApiIgnore/@Hidden失效求助

• 注解使用位置错误
  Swagger 3.0的@Hidden注解需要作用在字段、getter方法或类上。如果使用Lombok的@Data等自动生成getter的注解，仅给字段加@Hidden可能不生效——因为Swagger默认会解析getter方法对应的字段。可以直接把@Hidden加在目标字段的getter方法上：

  private String secretField;
  
  @Hidden
  public String getSecretField() {
      return secretField;
  }
  

  注意：@ApiIgnore是Swagger 2.x的注解，Swagger 3.0官方推荐使用@Hidden，若混用旧依赖会导致注解失效。

• 依赖版本与冲突问题
  确保使用Swagger 3.0的官方依赖（springdoc-openapi系列），不要与Springfox的Swagger依赖共存：

  • Maven（Spring Boot 3.x）：

    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
        <version>2.2.0</version>
    </dependency>
    

  • Gradle（Spring Boot 3.x）：

    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
    

  Spring Boot 2.x请使用springdoc-openapi-ui依赖。

• 全局配置强制展示字段
  若自定义了OpenAPI配置类（如@OpenAPIDefinition或OpenApiCustomizer），检查是否存在强制包含字段的逻辑。可通过自定义SchemaFilter手动移除目标字段：

  @Bean
  public OpenApiCustomizer openApiCustomizer() {
      return openApi -> openApi.getComponents().getSchemas().values().forEach(schema -> {
          // 替换为你要隐藏的字段名
          schema.getProperties().remove("secretField");
      });
  }
  

• 序列化框架影响
  若仅需在Swagger中隐藏字段但不影响接口返回，不要使用@JsonIgnore（该注解会让字段不被Jackson序列化）。但如果Swagger注解无效，可检查Jackson配置是否禁用了对Swagger注解的识别。

• 缓存问题
  Swagger UI可能缓存旧文档，尝试清空浏览器缓存或重启应用后，访问http://localhost:8080/swagger-ui.html重新查看。

内容的提问来源于stack exchange，提问作者Developer H