https://github.com/j0rgeserran0/jsonnamingpolicy

Naming policies for System.Text.Json
https://github.com/j0rgeserran0/jsonnamingpolicy

asp-net-core asp-net-core-5 asp-net-core-6 json json-naming-policies json-naming-policy kebab-case kebabcase net5 net6 netcore3 snake-case snakecase system-text-json

Last synced: 2 days ago
JSON representation

Naming policies for System.Text.Json

• Host: GitHub
• URL: https://github.com/j0rgeserran0/jsonnamingpolicy
• Owner: J0rgeSerran0
• License: mit
• Created: 2020-01-03T19:26:53.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-09-05T10:10:41.000Z (over 2 years ago)
• Last Synced: 2025-01-08T22:57:14.595Z (23 days ago)
• Topics: asp-net-core, asp-net-core-5, asp-net-core-6, json, json-naming-policies, json-naming-policy, kebab-case, kebabcase, net5, net6, netcore3, snake-case, snakecase, system-text-json
• Language: C#
• Homepage:
• Size: 56.6 KB
• Stars: 39
• Watchers: 7
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Namespace](https://img.shields.io/static/v1?label=Namespace&message=System.Text.Json&color=green)

![JSON Naming Policies](https://img.shields.io/static/v1?label=JSON%20Naming%20Policies&message=kebab-case%20and%20snake_case&color=9cf)

![Compatibility](https://img.shields.io/static/v1?label=Compatibility&message=.NET%20Core%203.1%20and%20.NET%206&color=success)

# JsonNamingPolicy

Naming policies for [System.Text.Json](https://docs.microsoft.com/en-us/dotnet/api/system.text.json?view=netcore-3.1)

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

> **Update April 5 2022**

> 

> Unlikely it will be added in .NET 7

> 

![afbeelding](https://user-images.githubusercontent.com/9028898/187986014-8d87f1f2-4e05-45fb-a256-6a8a802c0486.png)

> **Update Jul 23 2021**

> 

> Microsoft has moved the implementation of kebab-case and snake_case to .NET 7

>

> ![IMAGE](images/20210723.jpg)

>

> Additional information [here](https://github.com/dotnet/runtime/issues/782)

## NuGet Package

> **Update Oct 13 2021 - NuGet Package**

> **NickJohn** published 6 months ago, a NuGet Package with the code I share here.

> 

> You can incorporate the code easily inside of your developments.

> 

> You will find this NuGet Package **[here](https://www.nuget.org/packages/JorgeSerrano.Json.JsonSnakeCaseNamingPolicy)**

>  

> Thanks a lot **NickeJohn**

> 

## 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](https://github.com/hez2010/corefx/blob/c54ddc76da61c50576eff92e3add9caf7107f8af/src/System.Text.Json/tests/Serialization/SnakeCaseUnitTests.cs)

### Use

```csharp

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

```csharp

{"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

```csharp

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

```csharp

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

```