.NET Core: Remove null fields from API JSON response

by
.NET Core 1.0

In Startup.cs, you can attach JsonOptions to the service collection and set various configurations, including removing null values, there:

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

Instead of this line:

options.SerializerSettings.NullValueHandling = NullValueHandling.Ignore;

Use:

options.JsonSerializerOptions.IgnoreNullValues = true;
.NET 5.0

Instead of both variants above, use:

 options.JsonSerializerOptions.DefaultIgnoreCondition 
                       = JsonIgnoreCondition.WhenWritingNull;

The variant from .NET Core 3.1 still works, but it is marked as NonBrowsable (so you never get the IntelliSense hint about this parameter), so it is very likely that it is going to be obsoleted at some point.

More Related Contents:

  1. .NET NewtonSoft JSON deserialize map to a different property name
  2. Convert Dictionary to JSON in Swift
  3. How to perform partial object serialization providing “paths” using Newtonsoft JSON.NET
  4. Lowercase JSON key names with JSON Marshal in Go
  5. Standardized way to serialize JSON to query string?
  6. How can I customize serialization of a list of JAXB objects to JSON?
  7. What is deserialize and serialize in JSON?
  8. How to use Newtonsoft.Json as default in Asp.net Core Web Api?
  9. Json Java serialization that works with GWT [closed]
  10. Why would you use a string in JSON to represent a decimal number
  11. Serialize in JSON a base64 encoded data
  12. How can I deserialize an optional field with custom functions using Serde?
  13. Converting object to an encodable object failed
  14. Call json.Unmarshal inside UnmarshalJSON function without causing stack overflow
  15. How to globally set default options for System.Text.Json.JsonSerializer?
  16. Kotlin Json Parser
  17. Is there a streaming API for JSON? [closed]
  18. How to make HTTP Post request with JSON body in Swift
  19. Convert JSON format to CSV format for MS Excel [closed]
  20. Nested ng-repeat
  21. Disable Hypertext Application Language (HAL) in JSON?
  22. Spring Security and JSON Authentication
  23. Json handling in ROBOT
  24. Exporting JSON to environment variables
  25. Get IIS6 to serve JSON files (inc. POST,GET)?
  26. Angular2 Ansychronous bootstrapping with external json configuration file
  27. Only allow properties that are declared in JSON schema
  28. Jackson JSON serialization, recursion avoidance by level defining
  29. Passing UTC DateTime to Web API HttpGet Method results in local time
  30. How to dynamically display a multiline text in D3.js?

Leave a Comment