Deny null-value properties in ASP.NET Web API

Question

I created an ASP.Net WEB API project that will be used by the mobile application. I need a json response to omit the null properties instead of returning them as property: null .

How can i do this?

Answer 1

In WebApiConfig :

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

Or, if you want more control, you can replace the entire formatter:

  var jsonformatter = new JsonMediaTypeFormatter { SerializerSettings = { NullValueHandling = NullValueHandling.Ignore } }; config.Formatters.RemoveAt(0); config.Formatters.Insert(0, jsonformatter); 

Answer 2

I ended up with this piece of code in the startup.cs file using ASP.NET5 1.0.0-beta7

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

Answer 3

If you use vnext, in vnext web api projects, add this code to the startup.cs file.

  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); }); } 

Answer 4

I know this topic has been around for about two years, but if you go back to the JSON.NET documentation, it has detailed information on how to solve the problem of reducing the serialized JSON size for different scenarios, such as ignoring all null, ignoring all the values by default, ignoring null or default value only for certain properties, etc .:

http://www.newtonsoft.com/json/help/html/reducingserializedjsonsize.htm