ASP.NET Core - Json serializer settings Enum as string and ignore null values

Startup.cs

public class Startup
{
  public IServiceProvider ConfigureServices(IServiceCollection services)
  {
    services.AddMvc().AddJsonOptions(options =>
    {
      options.SerializerSettings.Converters.Add(new Newtonsoft.Json.Converters.StringEnumConverter());
      options.SerializerSettings.NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore;
    });
  }
}

You saved me! Thanks bro!

You saved me! Thanks bro!

Maybe this would help somebody. The same code for .net core 3.0 will look like this:

services.AddMvc()
    .AddJsonOptions(options => {
        options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
        options.JsonSerializerOptions.IgnoreNullValues = true;
    });

You saved me! Thanks bro!

You saved me! Thanks bro!

You saved me! Thanks bro!

Nice!

using System.Text.Json.Serialization;
...

services
    .AddControllers()
    .AddNewtonsoftJson()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
        options.JsonSerializerOptions.IgnoreNullValues = true;
    });

Working in .NET core 5.0

Make sure to include AddNewtonsoftJson() if you're using JSON PATCH. Otherwise it wont work.

Nice!

using System.Text.Json.Serialization;
...

services
    .AddControllers()
    .AddNewtonsoftJson()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
        options.JsonSerializerOptions.IgnoreNullValues = true;
    });

Working in .NET core 5.0

Make sure to include AddNewtonsoftJson() if you're using JSON PATCH. Otherwise it wont work.

thank you!

You saved me! Thanks bro!

Saving bros since 2018.

You saved me for the 3rd time! Thanks bro!

You saved me! Thanks bro!

You saved me! Thanks bro!

You saved me! Thanks bro! 🤣

You saved me! Thanks bro!

You saved me! Thanks bro!

For dotnet 6 a few options were deprecated

        .AddJsonOptions(options =>
        {
            options.JsonSerializerOptions.WriteIndented = true;

            // serialize enums as strings in api responses (e.g. Role)
            options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());

            // ignore omitted parameters on models to enable optional params (e.g. User update)
            options.JsonSerializerOptions.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull;
        });```