在ASP.NET Web API上抑制具有null值的属性

Question

我已经创建了一个将由移动应用程序使用的ASP.Net WEB API项目.我需要响应json省略null属性而不是返回它们property: null.

我怎样才能做到这一点？

Answer 1

在WebApiConfig:

config.Formatters.JsonFormatter.SerializerSettings = 
                 new JsonSerializerSettings {NullValueHandling = NullValueHandling.Ignore};

或者,如果您想要更多控制,可以替换整个格式化程序:

var jsonformatter = new JsonMediaTypeFormatter
{
    SerializerSettings =
    {
        NullValueHandling = NullValueHandling.Ignore
    }
};

config.Formatters.RemoveAt(0);
config.Formatters.Insert(0, jsonformatter);

Answer 2

我使用ASP.NET5 1.0.0-beta7在startup.cs文件中得到了这段代码

services.AddMvc().AddJsonOptions(options =>
{
    options.SerializerSettings.NullValueHandling = NullValueHandling.Ignore;
});

Answer 3

对于 ASP.NET Core 3.0，代码中的ConfigureServices()方法Startup.cs应包含：

services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.IgnoreNullValues = true;
    });

Answer 4

您还可以使用[DataContract]和[DataMember(EmitDefaultValue=false)]属性

Answer 5

如果您使用的是 vnext，在 vnext web api 项目中，将此代码添加到 startup.cs 文件中。

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc().Configure<MvcOptions>(options =>
        {
            int position = options.OutputFormatters.FindIndex(f =>  f.Instance is JsonOutputFormatter);

            var settings = new JsonSerializerSettings()
            {
                NullValueHandling = NullValueHandling.Ignore
            };

            var formatter = new JsonOutputFormatter();
            formatter.SerializerSettings = settings;

            options.OutputFormatters.Insert(position, formatter);
        });

    }