如何让模型字段数据库必填但Swagger忽略？已用[JSONIGNORE]仍无效

1. 数据库层面设置字段必填 #

使用JPA的@Column(nullable = false)注解标记字段，确保数据库中该字段为必填项，这个配置不会影响Swagger文档的展示逻辑。

示例代码：

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;

@Entity
public class YourEntity {
    @Id
    private Long id;

    // 数据库强制必填
    @Column(nullable = false)
    private String requiredDbField;

    // 其他字段...
}

2. Swagger层面隐藏目标字段 #

@JSONIGNORE是Jackson的序列化注解，仅控制JSON的序列化/反序列化行为，不会影响Swagger的文档生成，所以需要用Swagger专属的注解来隐藏字段：

场景1：使用Swagger 2（Springfox） #

给目标字段添加@ApiIgnore或@ApiModelProperty(hidden = true)注解，即可在Swagger文档中完全隐藏该字段（包括移除必填标记）。

示例1（@ApiIgnore）：

import io.swagger.annotations.ApiIgnore;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;

@Entity
public class YourEntity {
    @Id
    private Long id;

    @Column(nullable = false)
    @ApiIgnore // Swagger文档中忽略该字段
    private String requiredDbField;
}

示例2（@ApiModelProperty(hidden = true)）：

import io.swagger.annotations.ApiModelProperty;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;

@Entity
public class YourEntity {
    @Id
    private Long id;

    @Column(nullable = false)
    @ApiModelProperty(hidden = true) // Swagger文档中隐藏字段
    private String requiredDbField;
}

场景2：使用SpringDoc（OpenAPI 3） #

如果是Spring Boot 2.7及以上版本常用的SpringDoc，需要使用@Schema(hidden = true)注解来隐藏字段：

import io.swagger.v3.oas.annotations.media.Schema;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;

@Entity
public class YourEntity {
    @Id
    private Long id;

    @Column(nullable = false)
    @Schema(hidden = true) // OpenAPI文档中隐藏字段
    private String requiredDbField;
}

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