json - .NET 核心 : Remove null fields from API JSON response

Question

在 .NET Core 1.0(所有 API 响应)的全局级别上，如何配置 Startup.cs 以便在 JSON 响应中删除/忽略空字段？

使用 Newtonsoft.Json，您可以将以下属性应用于属性，但我想避免将其添加到每个属性:

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string FieldName { get; set; }
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string OtherName { get; set; }

Answer 1

.NET Core 1.0

在Startup.cs中，您可以将JsonOptions附加到服务集合并设置各种配置，包括删除空值，有:

public void ConfigureServices(IServiceCollection services)
{
     services.AddMvc()
             .AddJsonOptions(options => {       
                  options.SerializerSettings
                         .NullValueHandling = NullValueHandling.Ignore;
     });
}

.NET Core 3.1

代替这一行:

options.SerializerSettings.NullValueHandling = NullValueHandling.Ignore;

用途:

options.JsonSerializerOptions.IgnoreNullValues = true;

.NET 5.0

代替上述两种变体，使用:

 options.JsonSerializerOptions.DefaultIgnoreCondition 
                       = JsonIgnoreCondition.WhenWritingNull;

.NET Core 3.1 的变体仍然有效，但它被标记为 NonBrowsable (因此您永远不会收到有关此参数的 IntelliSense 提示)，因此它很可能是在某个时候过时了。