knife4j如何隐藏模型

### 关于 Knife4j 中隐藏模型的配置 在 Knife4j 中，可以通过自定义全局操作或特定 API 的文档描述来控制显示的内容。为了隐藏某些模型，通常的做法是在 Swagger 或 OpenAPI 文档生成过程中调整相应的设置。 #### 方法一：通过 `@ApiModelProperty` 注解排除字段 如果希望隐藏某个具体的属性而不是整个模型，则可以在实体类中使用 `@ApiModelProperty(hidden=true)` 来标记不希望展示给用户的字段： ```java import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; @ApiModel(description="User Details") public class User { @ApiModelProperty(value = "用户名", required = true) private String username; @ApiModelProperty(hidden = true) // 此处表示此字段不会被Knife4j显示 private Integer age; // getter and setter methods... } ``` #### 方法二：利用 `OpenApiCustomiser` 接口定制化处理 另一种方式是创建一个实现了 `org.springdoc.core.customizers.OpenApiCustomiser` 接口的 Bean，在其中编写逻辑移除不需要暴露出去的数据结构。这种方式更加灵活，适用于批量操作多个模型的情况。 ```java import org.springdoc.core.customizers.OpenApiCustomiser; import springfox.documentation.service.Tag; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration; import org.springframework.context.annotation.Configuration; import java.util.List; import static springfox.documentation.schema.AlternateTypes.*; @Configuration @EnableSwagger2WebMvc public class SwaggerConfig { public Docket api() { return new Docket(DocumentationType.OAS_30) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } @Bean public OpenApiCustomiser customGlobalHeaderOpenApiCustomiser() { return openApi -> { List<Schema> schemasToRemove = Arrays.asList( new Schema().$ref("#/components/schemas/User"), new Schema().$ref("#/components/schemas/Order")); // Remove specified models from the components section. Map<String, Object> components = (Map<String, Object>)openApi.getComponents(); ((List<Map<String,Object>>)components.get("schemas")).removeIf(schema->{ boolean shouldRemove = false; for(Schema s : schemasToRemove){ if(((String)s.$ref).equals((String)((Map<String,String>)schema).get("$ref"))){ shouldRemove = true; break; } } return shouldRemove; }); }; } } ``` 上述两种方案都可以有效地帮助开发者管理并优化 API 文档中的信息呈现[^1]。