EF Core中POST创建Order的JSON转换及关联可选性问题

问题背景 #

定义了以下实体类：

public class Order 
{
    public int Id { get; set; }
    public string Name { get; set; }
    public OrderGroup OrderGroup { get; set; }
}

public class OrderGroup 
{
    public int Id { get; set; }
    public string Name { get; set }
    public Order Order { get; set; }
}

通过POST请求创建Order时，Swagger抛出两个错误：

• "Order字段是必需的"
• "JSON值无法转换为<API.Entities.Order>"

仅在请求payload中将OrderGroup.order设为null可临时解决，但需求是创建Order时可选择是否关联OrderGroup（即允许完全不传OrderGroup字段）。尝试给OrderGroup属性添加?标记为可空后仍报错，希望通过数据注解解决，暂未使用modelBuilder。

数据注解解决方案 #

问题根源是实体类间的循环引用导致序列化/反序列化冲突，同时未正确配置可选属性的序列化规则。以下是具体修改步骤：

1. 修复语法错误 #

首先补全OrderGroup类中Name属性的分号（原代码遗漏）：

public string Name { get; set; }

2. 配置可空属性与循环引用忽略 #

根据你使用的JSON序列化库，添加对应的数据注解：

情况1：使用System.Text.Json（ASP.NET Core默认）

修改实体类，给导航属性添加[JsonIgnore]并配置空值时忽略，同时标记属性为可空：

public class Order 
{
    public int Id { get; set; }
    public string Name { get; set; }
    // 空值时忽略该属性，避免循环引用序列化
    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
    public OrderGroup? OrderGroup { get; set; }
}

public class OrderGroup 
{
    public int Id { get; set; }
    public string Name { get; set; }
    // 空值时忽略该属性，避免循环引用序列化
    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
    public Order? Order { get; set; }
}

情况2：使用Newtonsoft.Json（Json.NET）

如果项目使用Newtonsoft.Json，改用[JsonProperty]配置空值忽略：

public class Order 
{
    public int Id { get; set; }
    public string Name { get; set; }
    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
    public OrderGroup? OrderGroup { get; set; }
}

public class OrderGroup 
{
    public int Id { get; set; }
    public string Name { get; set; }
    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
    public Order? Order { get; set; }
}

3. 效果说明 #

修改后：

• 创建Order时可完全不传OrderGroup字段，该属性会被自动设为null，不会触发必填校验
• 序列化时会忽略空值的循环引用属性，避免Swagger生成错误的请求模型，同时解决JSON转换失败问题

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