Skip to content

Generate Enum-Dictionary-Keys (analogous to Newtonsoft) #2825

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
merged 8 commits into from
Apr 24, 2024
Merged

Generate Enum-Dictionary-Keys (analogous to Newtonsoft) #2825

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1363733
Generate Enum-Dictionary-Keys (analogous to Newtonsoft, since STJ doe…
angelaki Apr 23, 2024
980e899
Respect StringEnumConverter presence
angelaki Apr 23, 2024
dec0243
Test for Dictionary Enum Key-Value with StringEnumConverter
angelaki Apr 23, 2024
7dd2216
Removed StringEnumConverter-Check - Enums are always serialized as st…
angelaki Apr 23, 2024
3a21028
Fix Enum-Test
angelaki Apr 24, 2024
f153949
Check actual Dictionary key names
angelaki Apr 24, 2024
6e9b334
Update test/Swashbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/Js…
angelaki Apr 24, 2024
136aaec
Just compare enum names für Dictionary-Test
angelaki Apr 24, 2024
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
16 changes: 15 additions & 1 deletion src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/JsonSerializerDataContractResolver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,24 @@ public DataContract GetDataContractForType(Type type)

if (IsSupportedDictionary(type, out Type keyType, out Type valueType))
{
IEnumerable<string> keys = null;

if (keyType.IsEnum)
{
// This is a special case where we know the possible key values
var enumValuesAsJson = keyType.GetEnumValues()
.Cast<object>()
.Select(value => JsonConverterFunc(value));

keys = enumValuesAsJson.Any(json => json.StartsWith("\""))
? enumValuesAsJson.Select(json => json.Replace("\"", string.Empty))
: keyType.GetEnumNames();
}

return DataContract.ForDictionary(
underlyingType: type,
valueType: valueType,
keys: null, // STJ doesn't currently support dictionaries with enum key types
keys: keys,
jsonConverter: JsonConverterFunc);
}

Expand Down
11 changes: 11 additions & 0 deletions ...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -770,6 +770,17 @@ public void GenerateSchema_HonorsSerializerOption_StringEnumConverter(
Assert.Equal(expectedDefaultAsJson, propertySchema.Default.ToJson());
}

[Fact]
public void GenerateSchema_HonorsEnumDictionaryKeys_StringEnumConverter()
{
var subject = Subject();
var schemaRepository = new SchemaRepository();

var referenceSchema = subject.GenerateSchema(typeof(Dictionary<IntEnum, string>), schemaRepository);

Assert.Equal(typeof(IntEnum).GetEnumNames(), referenceSchema.Properties.Keys);
}

[Fact]
public void GenerateSchema_HonorsSerializerAttribute_StringEnumConverter()
{
Expand Down