Add support for any kind of example object when schema is string type…

… preferring the serialized result. Fixes domaindrivendev#2088
Havunen · Feb 18, 2024 · 8e3861d · 8e3861d
1 parent 2d2d151
commit 8e3861d
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 2 deletions.
diff --git a/src/DotSwashbuckle.AspNetCore.SwaggerGen/XmlComments/ExampleParser.cs b/src/DotSwashbuckle.AspNetCore.SwaggerGen/XmlComments/ExampleParser.cs
@@ -14,13 +14,26 @@ SchemaRepository schemaRepository
         )
         {
             var resolvedType = schema?.ResolveType(schemaRepository);
-            var shouldBeQuoted = (
+            var isStringSchema = (
                 string.Equals(resolvedType, "string", StringComparison.Ordinal) ||
                 string.Equals(resolvedType, "array", StringComparison.Ordinal)
             ) && !string.Equals(example, "null", StringComparison.Ordinal);
             var exampleValue = WhiteSpaceCleaner.Condense(example);
 
-            return OpenApiAnyFactory.CreateFromJson(shouldBeQuoted ? $"\"{exampleValue}\"" : exampleValue);
+
+            var serializedSchema = OpenApiAnyFactory.CreateFromJson(exampleValue);
+
+            if (serializedSchema != null)
+            {
+                return serializedSchema;
+            }
+
+            if (isStringSchema)
+            {
+                return new OpenApiString(exampleValue);
+            }
+
+            return null;
         }
     }
 }
diff --git a/test/DotSwashbuckle.AspNetCore.SwaggerGen.Test/DotSwashbuckle.AspNetCore.SwaggerGen.Test.xml b/test/DotSwashbuckle.AspNetCore.SwaggerGen.Test/DotSwashbuckle.AspNetCore.SwaggerGen.Test.xml
diff --git a/test/DotSwashbuckle.AspNetCore.SwaggerGen.Test/Fixtures/XmlAnnotatedType.cs b/test/DotSwashbuckle.AspNetCore.SwaggerGen.Test/Fixtures/XmlAnnotatedType.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Runtime.Serialization;
 using DotSwashbuckle.AspNetCore.TestSupport;
 
 namespace DotSwashbuckle.AspNetCore.SwaggerGen.Test
@@ -80,6 +81,22 @@ public class XmlAnnotatedType
         /// </example>
         public string MultiLineSummaryExample { get; set; }
 
+        /// <sumary>
+        /// For test only
+        /// </sumary>
+        /// <value>For test only</value>
+        /// <example>&quot;Test-Test-Test&quot;</example>
+        [DataMember(Name = "testProperty", EmitDefaultValue = false)]
+        public string QuoteProperty { get; set; }
+
+        /// <sumary>
+        /// For test only
+        /// </sumary>
+        /// <value>For test only</value>
+        /// <example>{"someKey": "someValue"}</example>
+        [DataMember(Name = "testProperty", EmitDefaultValue = false)]
+        public string KvpExampleProperty { get; set; }
+
         /// <summary>
         /// Summary for StringPropertyWithUri
         /// </summary>

diff --git a/test/DotSwashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlCommentsSchemaFilterTests.cs b/test/DotSwashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlCommentsSchemaFilterTests.cs
@@ -74,6 +74,8 @@ public void Apply_SetsDescription_FromPropertySummaryTag(
         [InlineData(typeof(XmlAnnotatedType), nameof(XmlAnnotatedType.StringPropertyWithNullExample), "string", "null")]
         [InlineData(typeof(XmlAnnotatedType), nameof(XmlAnnotatedType.StringPropertyWithUri), "string", "\"https://test.com/a?b=1&c=2\"")]
         [InlineData(typeof(XmlAnnotatedType), nameof(XmlAnnotatedType.MultiLineSummaryExample), "string", "\"When Number equals 2023/S 106-333284 Then Publication = 333284-2023\"")]
+        [InlineData(typeof(XmlAnnotatedType), nameof(XmlAnnotatedType.QuoteProperty), "string", "\"Test-Test-Test\"")]
+        [InlineData(typeof(XmlAnnotatedType), nameof(XmlAnnotatedType.KvpExampleProperty), "string", "{\n  \"someKey\": \"someValue\"\n}")]
         [InlineData(typeof(XmlAnnotatedRecord), nameof(XmlAnnotatedRecord.BoolProperty), "boolean", "true")]
         [InlineData(typeof(XmlAnnotatedRecord), nameof(XmlAnnotatedRecord.IntProperty), "integer", "10")]
         [InlineData(typeof(XmlAnnotatedRecord), nameof(XmlAnnotatedRecord.LongProperty), "integer", "4294967295")]