porting domaindrivendev/Swashbuckle.AspNetCore#2697 for Havunen/DotSw…

…ashbuckle#1
Havunen · Feb 12, 2024 · 7078ab7 · 7078ab7
1 parent ea2879c
commit 7078ab7
Show file tree

Hide file tree

Showing 6 changed files with 119 additions and 67 deletions.
diff --git a/src/DotSwashbuckle.AspNetCore.Newtonsoft/SchemaGenerator/NewtonsoftDataContractResolver.cs b/src/DotSwashbuckle.AspNetCore.Newtonsoft/SchemaGenerator/NewtonsoftDataContractResolver.cs
@@ -186,28 +186,47 @@ private IEnumerable<DataProperty> GetDataPropertiesFor(JsonObjectContract jsonOb
 
         private static readonly Dictionary<Type, Tuple<DataType, string>> PrimitiveTypesAndFormats = new Dictionary<Type, Tuple<DataType, string>>
         {
-            [ typeof(bool) ] = Tuple.Create(DataType.Boolean, (string)null),
-            [ typeof(byte) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(sbyte) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(short) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(ushort) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(int) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(uint) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(long) ] = Tuple.Create(DataType.Integer, "int64"),
-            [ typeof(ulong) ] = Tuple.Create(DataType.Integer, "int64"),
-            [ typeof(float) ] = Tuple.Create(DataType.Number, "float"),
-            [ typeof(double) ] = Tuple.Create(DataType.Number, "double"),
-            [ typeof(decimal) ] = Tuple.Create(DataType.Number, "double"),
-            [ typeof(byte[]) ] = Tuple.Create(DataType.String, "byte"),
-            [ typeof(string) ] = Tuple.Create(DataType.String, (string)null),
-            [ typeof(char) ] = Tuple.Create(DataType.String, (string)null),
-            [ typeof(DateTime) ] = Tuple.Create(DataType.String, "date-time"),
-            [ typeof(DateTimeOffset) ] = Tuple.Create(DataType.String, "date-time"),
-            [ typeof(Guid) ] = Tuple.Create(DataType.String, "uuid"),
-            [ typeof(Uri) ] = Tuple.Create(DataType.String, "uri"),
-            [ typeof(TimeSpan) ] = Tuple.Create(DataType.String, "date-span"),
-            [ typeof(DateOnly) ] = Tuple.Create(DataType.String, "date"),
-            [ typeof(TimeOnly) ] = Tuple.Create(DataType.String, "time")
+            [typeof(bool)] = Tuple.Create(DataType.Boolean, (string)null),
+            [typeof(bool?)] = Tuple.Create(DataType.Boolean, (string)null),
+            [typeof(byte)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(byte?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(sbyte)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(sbyte?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(short)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(short?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(ushort)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(ushort?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(int)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(int?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(uint)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(uint?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(long)] = Tuple.Create(DataType.Integer, "int64"),
+            [typeof(long?)] = Tuple.Create(DataType.Integer, "int64"),
+            [typeof(ulong)] = Tuple.Create(DataType.Integer, "int64"),
+            [typeof(ulong?)] = Tuple.Create(DataType.Integer, "int64"),
+            [typeof(float)] = Tuple.Create(DataType.Number, "float"),
+            [typeof(float?)] = Tuple.Create(DataType.Number, "float"),
+            [typeof(double)] = Tuple.Create(DataType.Number, "double"),
+            [typeof(double?)] = Tuple.Create(DataType.Number, "double"),
+            [typeof(decimal)] = Tuple.Create(DataType.Number, "double"),
+            [typeof(decimal?)] = Tuple.Create(DataType.Number, "double"),
+            [typeof(byte[])] = Tuple.Create(DataType.String, "byte"),
+            [typeof(string)] = Tuple.Create(DataType.String, (string)null),
+            [typeof(char)] = Tuple.Create(DataType.String, (string)null),
+            [typeof(char?)] = Tuple.Create(DataType.String, (string)null),
+            [typeof(DateTime)] = Tuple.Create(DataType.String, "date-time"),
+            [typeof(DateTime?)] = Tuple.Create(DataType.String, "date-time"),
+            [typeof(DateTimeOffset)] = Tuple.Create(DataType.String, "date-time"),
+            [typeof(DateTimeOffset?)] = Tuple.Create(DataType.String, "date-time"),
+            [typeof(Guid)] = Tuple.Create(DataType.String, "uuid"),
+            [typeof(Guid?)] = Tuple.Create(DataType.String, "uuid"),
+            [typeof(Uri)] = Tuple.Create(DataType.String, "uri"),
+            [typeof(TimeSpan)] = Tuple.Create(DataType.String, "date-span"),
+            [typeof(TimeSpan?)] = Tuple.Create(DataType.String, "date-span"),
+            [typeof(DateOnly)] = Tuple.Create(DataType.String, "date"),
+            [typeof(DateOnly?)] = Tuple.Create(DataType.String, "date"),
+            [typeof(TimeOnly)] = Tuple.Create(DataType.String, "time"),
+            [typeof(TimeOnly?)] = Tuple.Create(DataType.String, "time")
         };
     }
 }
diff --git a/...otSwashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/JsonSerializerDataContractResolver.cs b/...otSwashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/JsonSerializerDataContractResolver.cs
@@ -214,27 +214,45 @@ private IEnumerable<DataProperty> GetDataPropertiesFor(Type objectType, out Type
 
         private static readonly Dictionary<Type, Tuple<DataType, string>> PrimitiveTypesAndFormats = new Dictionary<Type, Tuple<DataType, string>>
         {
-            [ typeof(bool) ] = Tuple.Create(DataType.Boolean, (string)null),
-            [ typeof(byte) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(sbyte) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(short) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(ushort) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(int) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(uint) ] = Tuple.Create(DataType.Integer, "int32"),
-            [ typeof(long) ] = Tuple.Create(DataType.Integer, "int64"),
-            [ typeof(ulong) ] = Tuple.Create(DataType.Integer, "int64"),
-            [ typeof(float) ] = Tuple.Create(DataType.Number, "float"),
-            [ typeof(double) ] = Tuple.Create(DataType.Number, "double"),
-            [ typeof(decimal) ] = Tuple.Create(DataType.Number, "double"),
-            [ typeof(byte[]) ] = Tuple.Create(DataType.String, "byte"),
-            [ typeof(string) ] = Tuple.Create(DataType.String, (string)null),
-            [ typeof(char) ] = Tuple.Create(DataType.String, (string)null),
-            [ typeof(DateTime) ] = Tuple.Create(DataType.String, "date-time"),
-            [ typeof(DateTimeOffset) ] = Tuple.Create(DataType.String, "date-time"),
-            [ typeof(Guid) ] = Tuple.Create(DataType.String, "uuid"),
-            [ typeof(Uri) ] = Tuple.Create(DataType.String, "uri"),
-            [ typeof(DateOnly) ] = Tuple.Create(DataType.String, "date"),
-            [ typeof(TimeOnly) ] = Tuple.Create(DataType.String, "time")
+            [typeof(bool)] = Tuple.Create(DataType.Boolean, (string)null),
+            [typeof(bool?)] = Tuple.Create(DataType.Boolean, (string)null),
+            [typeof(byte)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(byte?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(sbyte)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(sbyte?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(short)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(short?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(ushort)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(ushort?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(int)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(int?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(uint)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(uint?)] = Tuple.Create(DataType.Integer, "int32"),
+            [typeof(long)] = Tuple.Create(DataType.Integer, "int64"),
+            [typeof(long?)] = Tuple.Create(DataType.Integer, "int64"),
+            [typeof(ulong)] = Tuple.Create(DataType.Integer, "int64"),
+            [typeof(ulong?)] = Tuple.Create(DataType.Integer, "int64"),
+            [typeof(float)] = Tuple.Create(DataType.Number, "float"),
+            [typeof(float?)] = Tuple.Create(DataType.Number, "float"),
+            [typeof(double)] = Tuple.Create(DataType.Number, "double"),
+            [typeof(double?)] = Tuple.Create(DataType.Number, "double"),
+            [typeof(decimal)] = Tuple.Create(DataType.Number, "double"),
+            [typeof(decimal?)] = Tuple.Create(DataType.Number, "double"),
+            [typeof(byte[])] = Tuple.Create(DataType.String, "byte"),
+            [typeof(string)] = Tuple.Create(DataType.String, (string)null),
+            [typeof(char)] = Tuple.Create(DataType.String, (string)null),
+            [typeof(char?)] = Tuple.Create(DataType.String, (string)null),
+            [typeof(DateTime)] = Tuple.Create(DataType.String, "date-time"),
+            [typeof(DateTime?)] = Tuple.Create(DataType.String, "date-time"),
+            [typeof(DateTimeOffset)] = Tuple.Create(DataType.String, "date-time"),
+            [typeof(DateTimeOffset?)] = Tuple.Create(DataType.String, "date-time"),
+            [typeof(Guid)] = Tuple.Create(DataType.String, "uuid"),
+            [typeof(Guid?)] = Tuple.Create(DataType.String, "uuid"),
+            [typeof(Uri)] = Tuple.Create(DataType.String, "uri"),
+            [typeof(DateOnly)] = Tuple.Create(DataType.String, "date"),
+            [typeof(DateOnly?)] = Tuple.Create(DataType.String, "date"),
+            [typeof(TimeOnly)] = Tuple.Create(DataType.String, "time"),
+            [typeof(TimeOnly?)] = Tuple.Create(DataType.String, "time")
         };
     }
 }
diff --git a/src/DotSwashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs b/src/DotSwashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs
@@ -30,15 +30,16 @@ public SchemaGenerator(SchemaGeneratorOptions generatorOptions, ISerializerDataC
             SchemaRepository schemaRepository,
             MemberInfo memberInfo = null,
             ParameterInfo parameterInfo = null,
-            ApiParameterRouteInfo routeInfo = null)
+            ApiParameterRouteInfo routeInfo = null,
+            bool isEffectiveTypeNeeded = true)
         {
             if (memberInfo != null)
                 return GenerateSchemaForMember(modelType, schemaRepository, memberInfo);
 
             if (parameterInfo != null)
                 return GenerateSchemaForParameter(modelType, schemaRepository, parameterInfo, routeInfo);
 
-            return GenerateSchemaForType(modelType, schemaRepository);
+            return GenerateSchemaForType(modelType, schemaRepository, isEffectiveTypeNeeded);
         }
 
         private OpenApiSchema GenerateSchemaForMember(
@@ -68,8 +69,8 @@ public SchemaGenerator(SchemaGeneratorOptions generatorOptions, ISerializerDataC
                 {
                     var requiredAttribute = customAttributes.OfType<RequiredAttribute>().FirstOrDefault();
                     schema.Nullable = _generatorOptions.SupportNonNullableReferenceTypes
-                        ? dataProperty.IsNullable && requiredAttribute==null && !memberInfo.IsNonNullableReferenceType()
-                        : dataProperty.IsNullable && requiredAttribute==null;
+                        ? dataProperty.IsNullable && requiredAttribute == null && !memberInfo.IsNonNullableReferenceType()
+                        : dataProperty.IsNullable && requiredAttribute == null;
 
                     schema.ReadOnly = dataProperty.IsReadOnly;
                     schema.WriteOnly = dataProperty.IsWriteOnly;
@@ -147,9 +148,9 @@ public SchemaGenerator(SchemaGeneratorOptions generatorOptions, ISerializerDataC
             return schema;
         }
 
-        private OpenApiSchema GenerateSchemaForType(Type modelType, SchemaRepository schemaRepository)
+        private OpenApiSchema GenerateSchemaForType(Type modelType, SchemaRepository schemaRepository, bool isEffectiveTypeNeeded = true)
         {
-            var dataContract = GetDataContractFor(modelType);
+            var dataContract = GetDataContractFor(modelType, isEffectiveTypeNeeded);
 
             var schema = _generatorOptions.UseOneOfForPolymorphism && IsBaseTypeWithKnownTypesDefined(dataContract, out var knownTypesDataContracts)
                 ? GeneratePolymorphicSchema(dataContract, schemaRepository, knownTypesDataContracts)
@@ -163,9 +164,9 @@ private OpenApiSchema GenerateSchemaForType(Type modelType, SchemaRepository sch
             return schema;
         }
 
-        private DataContract GetDataContractFor(Type modelType)
+        private DataContract GetDataContractFor(Type modelType, bool isEffectiveTypeNeeded = true)
         {
-            var effectiveType = Nullable.GetUnderlyingType(modelType) ?? modelType;
+            var effectiveType = isEffectiveTypeNeeded ? Nullable.GetUnderlyingType(modelType) ?? modelType : modelType;
             return _serializerDataContractResolver.GetDataContractForType(effectiveType);
         }
 
@@ -274,7 +275,8 @@ private OpenApiSchema CreatePrimitiveSchema(DataContract dataContract)
             var schema = new OpenApiSchema
             {
                 Type = dataContract.DataType.ToString().ToLower(CultureInfo.InvariantCulture),
-                Format = dataContract.DataFormat
+                Format = dataContract.DataFormat,
+                Nullable = Nullable.GetUnderlyingType(dataContract.UnderlyingType) != null
             };
 
             if (dataContract.UnderlyingType.IsEnum)
@@ -299,7 +301,7 @@ private OpenApiSchema CreateArraySchema(DataContract dataContract, SchemaReposit
             return new OpenApiSchema
             {
                 Type = "array",
-                Items = GenerateSchema(dataContract.ArrayItemType, schemaRepository),
+                Items = GenerateSchema(dataContract.ArrayItemType, schemaRepository, isEffectiveTypeNeeded: false),
                 UniqueItems = hasUniqueItems ? (bool?)true : null
             };
         }
@@ -487,4 +489,4 @@ private bool IsKnownSubType(DataContract dataContract, out DataContract baseType
             }
         }
     }
-}
+}
diff --git a/src/DotSwashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/ISchemaGenerator.cs b/src/DotSwashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/ISchemaGenerator.cs
@@ -12,6 +12,7 @@ public interface ISchemaGenerator
             SchemaRepository schemaRepository,
             MemberInfo memberInfo = null,
             ParameterInfo parameterInfo = null,
-            ApiParameterRouteInfo routeInfo = null);
+            ApiParameterRouteInfo routeInfo = null,
+            bool isEffectiveTypeNeeded = true);
     }
 }
diff --git a/...tSwashbuckle.AspNetCore.Newtonsoft.Test/SchemaGenerator/NewtonsoftSchemaGeneratorTests.cs b/...tSwashbuckle.AspNetCore.Newtonsoft.Test/SchemaGenerator/NewtonsoftSchemaGeneratorTests.cs
@@ -153,22 +153,28 @@ public void GenerateSchema_GeneratesReferencedDictionarySchema_IfDictionaryTypeI
         }
 
         [Theory]
-        [InlineData(typeof(int[]), "integer", "int32")]
-        [InlineData(typeof(IEnumerable<string>), "string", null)]
-        [InlineData(typeof(DateTime?[]), "string", "date-time")]
-        [InlineData(typeof(int[][]), "array", null)]
-        [InlineData(typeof(IList), null, null)]
+        [InlineData(typeof(int[]), "integer", "int32", false)]
+        [InlineData(typeof(int?[]), "integer", "int32", true)]
+        [InlineData(typeof(List<int?>), "integer", "int32", true)]
+        [InlineData(typeof(Nullable<int>[]), "integer", "int32", true)]
+        [InlineData(typeof(IEnumerable<string>), "string", null, false)]
+        [InlineData(typeof(DateTime[]), "string", "date-time", false)]
+        [InlineData(typeof(DateTime?[]), "string", "date-time", true)]
+        [InlineData(typeof(int[][]), "array", null, false)]
+        [InlineData(typeof(IList), null, null, false)]
         public void GenerateSchema_GeneratesArraySchema_IfEnumerableType(
             Type type,
             string expectedItemsType,
-            string expectedItemsFormat)
+            string expectedItemsFormat,
+            bool expectedItemsNullable)
         {
             var schema = Subject().GenerateSchema(type, new SchemaRepository());
 
             Assert.Equal("array", schema.Type);
             Assert.NotNull(schema.Items);
             Assert.Equal(expectedItemsType, schema.Items.Type);
             Assert.Equal(expectedItemsFormat, schema.Items.Format);
+            Assert.Equal(expectedItemsNullable, schema.Items.Nullable);
         }
 
         [Fact]

diff --git a/...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs b/...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs
@@ -149,22 +149,28 @@ public void GenerateSchema_GeneratesReferencedDictionarySchema_IfDictionaryTypeI
         }
 
         [Theory]
-        [InlineData(typeof(int[]), "integer", "int32")]
-        [InlineData(typeof(IEnumerable<string>), "string", null)]
-        [InlineData(typeof(DateTime?[]), "string", "date-time")]
-        [InlineData(typeof(int[][]), "array", null)]
-        [InlineData(typeof(IList), null, null)]
+        [InlineData(typeof(int[]), "integer", "int32", false)]
+        [InlineData(typeof(int?[]), "integer", "int32", true)]
+        [InlineData(typeof(List<int?>), "integer", "int32", true)]
+        [InlineData(typeof(Nullable<int>[]), "integer", "int32", true)]
+        [InlineData(typeof(IEnumerable<string>), "string", null, false)]
+        [InlineData(typeof(DateTime[]), "string", "date-time", false)]
+        [InlineData(typeof(DateTime?[]), "string", "date-time", true)]
+        [InlineData(typeof(int[][]), "array", null, false)]
+        [InlineData(typeof(IList), null, null, false)]
         public void GenerateSchema_GeneratesArraySchema_IfEnumerableType(
             Type type,
             string expectedItemsType,
-            string expectedItemsFormat)
+            string expectedItemsFormat,
+            bool expectedItemsNullable)
         {
             var schema = Subject().GenerateSchema(type, new SchemaRepository());
 
             Assert.Equal("array", schema.Type);
             Assert.NotNull(schema.Items);
             Assert.Equal(expectedItemsType, schema.Items.Type);
             Assert.Equal(expectedItemsFormat, schema.Items.Format);
+            Assert.Equal(expectedItemsNullable, schema.Items.Nullable);
         }
 
         [Fact]