Is there a built in way of using snake case as the naming policy for JSON in ASP.NET Core 3?

by

Just slight modification in pfx code to remove the dependency on Newtonsoft Json.Net.

String extension method to convert the given string to SnakeCase.

public static class StringUtils
{
    public static string ToSnakeCase(this string str)
    {
        return string.Concat(str.Select((x, i) => i > 0 && char.IsUpper(x) ? "_" + x.ToString() : x.ToString())).ToLower();
    }
}

Then in our SnakeCaseNamingPolicy we can do

public class SnakeCaseNamingPolicy : JsonNamingPolicy
{
    public static SnakeCaseNamingPolicy Instance { get; } = new SnakeCaseNamingPolicy();

    public override string ConvertName(string name)
    {
        // Conversion to other naming convention goes here. Like SnakeCase, KebabCase etc.
        return name.ToSnakeCase();
    }
}

The last step is to register our naming policy in Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers()            
        .AddJsonOptions(
            options => { 
                options.JsonSerializerOptions.PropertyNamingPolicy = 
                    SnakeCaseNamingPolicy.Instance;
            });
}

Using the model:

public class WeatherForecast
{
    public DateTime Date { get; set; }

    public int TemperatureCelcius { get; set; }

    public int TemperatureFahrenheit { get; set; }

    public string Summary { get; set; }
}

Json output:

{
  "date": "2019-10-28T08:26:14.878444+05:00",
  "temperature_celcius": 4,
  "temperature_fahrenheit": 0,
  "summary": "Scorching"
}

More Related Contents:

  1. System.Text.Json API is there something like IContractResolver
  2. System.Text.Json: How do I specify a custom name for an enum value?
  3. Command dotnet ef not found
  4. System.Text.Json: Deserialize JSON with automatic casting
  5. AddTransient, AddScoped and AddSingleton Services Differences
  6. How should I inject a DbContext instance into an IHostedService?
  7. How to instantiate a DbContext in EF Core
  8. Converting newtonsoft code to System.Text.Json in .net core 3. what’s equivalent of JObject.Parse and JsonProperty
  9. Enable OPTIONS header for CORS on .NET Core Web API
  10. ASP.NET Core 3.0 System.Text.Json Camel Case Serialization
  11. Hangfire – Multi tenant, ASP.NET Core – Resolving the correct tenant
  12. .NET Core and System.Drawing
  13. How to consume a Scoped service from a Singleton?
  14. Inject service into Action Filter
  15. Upload files and JSON in ASP.NET Core Web API
  16. How to read values from the querystring with ASP.NET Core?
  17. Change the JSON serialization settings of a single ASP.NET Core controller
  18. Using IConfiguration in C# Class Library
  19. How to set json serializer settings in asp.net core 3?
  20. System.Text.Json – Deserialize nested object as string
  21. Replace service registration in ASP.NET Core built-in DI container?
  22. How do I reference a .NET Framework project in a .NET Core project?
  23. Custom JSON serializer for optional property with System.Text.Json
  24. Refresh Token using Polly with Named Client
  25. Using a Scoped service in a Singleton in an Asp.Net Core app
  26. How to use SqlClient in ASP.NET Core?
  27. How to change the port number for Asp.Net core app?
  28. Filter Serilog logs to different sinks depending on context source?
  29. How to resolve .net core build error NETDSDK1061 and warning MSB3277
  30. Formatting DateTime in ASP.NET Core 3.0 using System.Text.Json

Leave a Comment