port domaindrivendev#2825 Generate Enum-Dictionary-Keys (analogous to…

… Newtonsoft)
Havunen · May 5, 2024 · 59fb631 · 59fb631
1 parent d3608fa
commit 59fb631
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 1 deletion.
diff --git a/...otSwashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/JsonSerializerDataContractResolver.cs b/...otSwashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/JsonSerializerDataContractResolver.cs
@@ -56,10 +56,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);
             }
 

diff --git a/...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs b/...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs
@@ -171,6 +171,17 @@ public void UInt128_HaveMinAndMax_DefinedInSchema()
             Assert.Equal(true, schema.Nullable);
         }
 
+        [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);
+        }
+
         [Theory]
         [InlineData(typeof(IntEnum), "integer", "int32", "2", "4", "8")]
         [InlineData(typeof(LongEnum), "integer", "int64", "2", "4", "8")]