Swagger生成客户端调用API时parcel_Triclops_Data序列化异常如何解决

你的报错核心是生成的客户端默认将Parcel_Triclops_Data属性标记为非空必填项，但接口实际返回的JSON中该字段值为null，Newtonsoft.Json反序列化时校验不通过触发异常。
触发该问题的常见场景：

• C# 8及以上版本默认启用非可空引用类型，你服务端定义的TriclopsParcelDataViewModel中Parcel_Triclops_Data属性没有加?可空标记，Swagger生成OpenAPI文档时自动将该字段标记为required: true，客户端生成工具就会按非空必填处理该字段。
• 客户端生成工具的默认配置将所有引用类型字段默认设为必填，或者序列化配置全局指定了Required = Required.Always规则。

你猜测的覆写客户端JSON序列化设置的思路是正确的，根据可修改的范围可以选择以下方案：

方案1：修改服务端模型（最优，从根源解决） #

在服务端的TriclopsParcelDataViewModel类中，将Parcel_Triclops_Data标记为可空引用类型：

// 加?表示该属性允许为null
public Parcel_Triclops_Data? Parcel_Triclops_Data { get; set; }

修改后重新生成Swagger文档，再重新生成客户端，新生成的代码会自动支持该字段为null的情况。

方案2：调整客户端JSON序列化配置 #

如果无法修改服务端代码，直接在客户端初始化时覆写Newtonsoft.Json的全局配置即可：

JsonConvert.DefaultSettings = () => new JsonSerializerSettings
{
    // 允许必填字段为null
    Required = Required.AllowNull,
    // 可选：忽略null值的序列化/反序列化处理
    NullValueHandling = NullValueHandling.Ignore
};

如果你只需要针对该接口的反序列化做特殊处理，不需要全局生效，也可以在调用客户端方法时手动传入序列化配置。

方案3：修改客户端生成配置 #

如果是用NSwag、OpenAPI Generator这类工具生成的客户端，可以在生成时直接配置参数：

• NSwag：开启GenerateNullableReferenceTypes配置项，生成的代码会自动携带可空标记
• OpenAPI Generator：添加nullableReferenceTypes=true的生成参数
  配置后重新生成的客户端不需要额外改代码就能兼容null值的场景。

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