JorgeSerrano.Json.JsonSnakeCaseNamingPolicy 0.9.0

⚠ Note

.NET 8 now has built-in support for snake_case and kebab-case JSON naming policies.

JsonNamingPolicy

Naming policies for System.Text.Json

This GitHub repo contains classes to change the name properties of a JSON into different naming conventions.

JsonSnakeCaseNamingPolicy

This class creates a policy to change the name properties of a JSON into SnakeCase (snake_case) used in some programming languages and APIs.

This code passes the tests that you will find in the corefx SnakeCaseUnitTests of Microsoft

Use

using JorgeSerrano.Json;
...
var options = new JsonSerializerOptions() { PropertyNamingPolicy = new JsonSnakeCaseNamingPolicy() };
var person = new Person() { FirstName = "Jorge", Birthday = DateTime.UtcNow, MyJobCity = "Madrid" };
var json = JsonSerializer.Serialize(person, options);

Result

{"first_name":"Jorge","birthday":"2020-01-03T20:00:59.6991482Z","my_job_city":"Madrid"}

JsonKebabCaseNamingPolicy

This class creates a policy to change the name properties of a JSON into KebabCase (kebab-case).

Use

using JorgeSerrano.Json;
...
var options = new JsonSerializerOptions() { PropertyNamingPolicy = new JsonKebabCaseNamingPolicy() };
var person = new Person() { FirstName = "Jorge", Birthday = DateTime.UtcNow, MyJobCity = "Madrid" };
var json = JsonSerializer.Serialize(person, options);

Result

{"first-name":"Jorge","birthday":"2020-01-03T20:00:59.6991482Z","my-job-city":"Madrid"}

Disclaimer

This library is written by J0rgeSerran0 on GitHub, not by me. I packaged and published it to NuGet just for convenience.