Skip to content

Serialize enum as string: net10.0, ConfigureHttpJsonOptions, DataContractJsonSerializer and source-generation samples #2160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vladimir-pecanac-main merged 2 commits into from
Aug 31, 2026
Merged

Serialize enum as string: net10.0, ConfigureHttpJsonOptions, DataContractJsonSerializer and source-generation samples #2160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29ca564
Serialize enum as string: retarget net10.0, ConfigureHttpJsonOptions,…
vladimir-pecanac-main Aug 30, 2026
9581838
Merge branch 'main' into seo/67044-enum-to-string
vladimir-pecanac-main Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions ...String/JsonSerialization.EnumAsString.Models/JsonSerialization.EnumAsString.Models.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
</Project>
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>

</Project>
35 changes: 16 additions & 19 deletions ...on.Native.EnumAsString.MinimalApi/JsonSerialization.Native.EnumAsString.MinimalApi.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
<Project Sdk="Microsoft.NET.Sdk.Web">

<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="System.Text.Json" Version="6.0.2" />
</ItemGroup>
<ItemGroup>
<InternalsVisibleTo Include="JsonSerialization.Native.EnumAsString.MinimalApiTests" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\JsonSerialization.EnumAsString.Models\JsonSerialization.EnumAsString.Models.csproj" />
</ItemGroup>

</Project>
<Project Sdk="Microsoft.NET.Sdk.Web">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>

<ItemGroup>
<InternalsVisibleTo Include="JsonSerialization.Native.EnumAsString.MinimalApiTests" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\JsonSerialization.EnumAsString.Models\JsonSerialization.EnumAsString.Models.csproj" />
</ItemGroup>

</Project>
29 changes: 14 additions & 15 deletions ...onSerializationOfEnumAsString/JsonSerialization.Native.EnumAsString.MinimalApi/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
using JsonSerialization.EnumAsString.Models;
using Microsoft.AspNetCore.Http.Json;
using System.Text.Json.Serialization;

var builder = WebApplication.CreateBuilder(args);
builder.Services.Configure<JsonOptions>(options =>
{
options.SerializerOptions.Converters.Add(new JsonStringEnumConverter());
});

var app = builder.Build();

app.MapGet("/poster", () => Canvas.Poster);
app.MapGet("/schedule", () => new { Description = "Exhibition", Day = DayOfWeek.Monday });

using JsonSerialization.EnumAsString.Models;
using System.Text.Json.Serialization;

var builder = WebApplication.CreateBuilder(args);
builder.Services.ConfigureHttpJsonOptions(options =>
{
options.SerializerOptions.Converters.Add(new JsonStringEnumConverter());
});

var app = builder.Build();

app.MapGet("/poster", () => Canvas.Poster);
app.MapGet("/schedule", () => new { Description = "Exhibition", Day = DayOfWeek.Monday });

app.Run();
17 changes: 8 additions & 9 deletions ...EnumAsString.MinimalApiTests/JsonSerialization.Native.EnumAsString.MinimalApiTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
<TargetFramework>net10.0</TargetFramework>
<Nullable>enable</Nullable>
<IsPackable>false</IsPackable>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="6.0.2" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
<PackageReference Include="System.Text.Json" Version="6.0.2" />
<PackageReference Include="xunit" Version="2.4.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
<PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="10.0.11" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.9.0" />
<PackageReference Include="xunit" Version="2.9.3" />
<PackageReference Include="xunit.runner.visualstudio" Version="3.1.5">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="coverlet.collector" Version="3.1.0">
<PackageReference Include="coverlet.collector" Version="10.0.1">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\JsonSerialization.Native.EnumAsString.MinimalApi\JsonSerialization.Native.EnumAsString.MinimalApi.csproj" />
<ItemGroup>
<ProjectReference Include="..\JsonSerialization.Native.EnumAsString.MinimalApi\JsonSerialization.Native.EnumAsString.MinimalApi.csproj" />
</ItemGroup>

</Project>
33 changes: 15 additions & 18 deletions ...ialization.Native.EnumAsString.WebApi/JsonSerialization.Native.EnumAsString.WebApi.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
<Project Sdk="Microsoft.NET.Sdk.Web">

<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>
<ItemGroup>
<InternalsVisibleTo Include="JsonSerialization.Native.EnumAsStringTests" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="System.Text.Json" Version="6.0.2" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\JsonSerialization.EnumAsString.Models\JsonSerialization.EnumAsString.Models.csproj" />
</ItemGroup>

</Project>
<Project Sdk="Microsoft.NET.Sdk.Web">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>
<ItemGroup>
<InternalsVisibleTo Include="JsonSerialization.Native.EnumAsStringTests" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\JsonSerialization.EnumAsString.Models\JsonSerialization.EnumAsString.Models.csproj" />
</ItemGroup>

</Project>
30 changes: 14 additions & 16 deletions ...p/JsonSerializationOfEnumAsString/JsonSerialization.Native.EnumAsString.WebApi/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
using System.Text.Json.Serialization;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers()
.AddJsonOptions(options =>
{
options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
});

var app = builder.Build();

app.UseAuthorization();

app.MapControllers();

using System.Text.Json.Serialization;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers()
.AddJsonOptions(options =>
{
options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
});

var app = builder.Build();

app.MapControllers();

app.Run();
15 changes: 15 additions & 0 deletions ...ionOfEnumAsString/JsonSerialization.Native.EnumAsStringTests/CustomNames/ToggleControl.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
namespace JsonSerialization.Native.EnumAsStringTests.CustomNames;

public record struct ToggleControl(string Name, ToggleType Type);

public enum ToggleType
{
[JsonStringEnumMemberName("Enable/Disable")]
EnableDisable,

[JsonStringEnumMemberName("Visible/Hidden")]
VisibleHidden,

[JsonStringEnumMemberName("Editable/Readonly")]
EditableReadonly,
}
112 changes: 68 additions & 44 deletions ...nOfEnumAsString/JsonSerialization.Native.EnumAsStringTests/CustomSerializationUnitTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,68 @@
using JsonSerialization.EnumAsString.Models;

namespace JsonSerialization.Native.EnumAsStringTests;

public class CustomSerializationUnitTest : UnitTestBase
{
[Fact]
public void GivenEnum_WhenSerializeWithPropertyCamelCasePolicy_ThenDoesNotCamelCaseEnumValues()
{
var options = new JsonSerializerOptions
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase
};
options.Converters.Add(new JsonStringEnumConverter());

var json = JsonSerializer.Serialize(Canvas.Poster, options);

Assert.Equal("{\"name\":\"Poster\",\"backColor\":\"LightGray\",\"medium\":\"Water\",\"pen\":{\"name\":\"Simple\",\"color\":\"Red\"}}", json);
}

[Fact]
public void GivenEnum_WhenSerializeWithEnumCamelCasePolicy_ThenCamelCaseEnumValues()
{
var options = new JsonSerializerOptions();
options.Converters.Add(new JsonStringEnumConverter(JsonNamingPolicy.CamelCase));

var json = JsonSerializer.Serialize(Canvas.Poster, options);

Assert.Equal("{\"Name\":\"Poster\",\"BackColor\":\"lightGray\",\"Medium\":\"water\",\"Pen\":{\"Name\":\"Simple\",\"Color\":\"red\"}}", json);
}

[Fact]
public void GivenEnum_WhenDecoratedWithEnumMember_ThenIgnoresEnumMemberOnSerialize()
{
var controls = new ToggleControl[]
{
new("toggle1", ToggleType.EnableDisable),
new("toggle2", ToggleType.VisibleHidden)
};
var json = SerializeWithStringEnum(controls);

Assert.Equal("[{\"Name\":\"toggle1\",\"Type\":\"EnableDisable\"},{\"Name\":\"toggle2\",\"Type\":\"VisibleHidden\"}]", json);
}
}
using JsonSerialization.EnumAsString.Models;

namespace JsonSerialization.Native.EnumAsStringTests;

public class CustomSerializationUnitTest : UnitTestBase
{
[Fact]
public void GivenEnum_WhenSerializeWithPropertyCamelCasePolicy_ThenDoesNotCamelCaseEnumValues()
{
var options = new JsonSerializerOptions
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase
};
options.Converters.Add(new JsonStringEnumConverter());

var json = JsonSerializer.Serialize(Canvas.Poster, options);

Assert.Equal("{\"name\":\"Poster\",\"backColor\":\"LightGray\",\"medium\":\"Water\",\"pen\":{\"name\":\"Simple\",\"color\":\"Red\"}}", json);
}

[Fact]
public void GivenEnum_WhenSerializeWithEnumCamelCasePolicy_ThenCamelCaseEnumValues()
{
var options = new JsonSerializerOptions();
options.Converters.Add(new JsonStringEnumConverter(JsonNamingPolicy.CamelCase));

var json = JsonSerializer.Serialize(Canvas.Poster, options);

Assert.Equal("{\"Name\":\"Poster\",\"BackColor\":\"lightGray\",\"Medium\":\"water\",\"Pen\":{\"Name\":\"Simple\",\"Color\":\"red\"}}", json);
}

[Fact]
public void GivenEnum_WhenDecoratedWithEnumMember_ThenIgnoresEnumMemberOnSerialize()
{
var controls = new ToggleControl[]
{
new("toggle1", ToggleType.EnableDisable),
new("toggle2", ToggleType.VisibleHidden)
};
var json = SerializeWithStringEnum(controls);

Assert.Equal("[{\"Name\":\"toggle1\",\"Type\":\"EnableDisable\"},{\"Name\":\"toggle2\",\"Type\":\"VisibleHidden\"}]", json);
}

[Fact]
public void GivenEnum_WhenDecoratedWithJsonStringEnumMemberName_ThenSerializeAsSpecifiedString()
{
var controls = new CustomNames.ToggleControl[]
{
new("toggle1", CustomNames.ToggleType.EnableDisable),
new("toggle2", CustomNames.ToggleType.VisibleHidden)
};

var json = SerializeWithStringEnum(controls);

Assert.Equal("[{\"Name\":\"toggle1\",\"Type\":\"Enable/Disable\"},{\"Name\":\"toggle2\",\"Type\":\"Visible/Hidden\"}]", json);
}

[Fact]
public void GivenEnum_WhenDecoratedWithJsonStringEnumMemberNameButNoConverterRegistered_ThenSerializeAsNumber()
{
var control = new CustomNames.ToggleControl("toggle1", CustomNames.ToggleType.EnableDisable);

var json = Serialize(control);

Assert.Equal("{\"Name\":\"toggle1\",\"Type\":0}", json);
}
}
Loading
Loading