Add support for required keyword (#2810)

keahpeters · web-flow · commit 8a23f0a072d2 · 2024-04-18T17:55:43.000+01:00
Add support for `required` keyword.
diff --git a/src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs b/src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs
@@ -67,13 +67,25 @@ private OpenApiSchema GenerateSchemaForMember(
                 if (dataProperty != null)
                 {
                     var requiredAttribute = customAttributes.OfType<RequiredAttribute>().FirstOrDefault();
+
+                    schema.ReadOnly = dataProperty.IsReadOnly;
+                    schema.WriteOnly = dataProperty.IsWriteOnly;
+
+#if NET7_0_OR_GREATER
+                    var hasRequiredMemberAttribute = customAttributes.OfType<System.Runtime.CompilerServices.RequiredMemberAttribute>().Any();
+
+                    schema.Nullable = _generatorOptions.SupportNonNullableReferenceTypes
+                        ? dataProperty.IsNullable && requiredAttribute == null && !hasRequiredMemberAttribute && !memberInfo.IsNonNullableReferenceType()
+                        : dataProperty.IsNullable && requiredAttribute == null && !hasRequiredMemberAttribute;
+
+                    schema.MinLength = modelType == typeof(string) && (hasRequiredMemberAttribute || requiredAttribute is { AllowEmptyStrings: false }) ? 1 : null;
+#else
                     schema.Nullable = _generatorOptions.SupportNonNullableReferenceTypes
                         ? dataProperty.IsNullable && requiredAttribute==null && !memberInfo.IsNonNullableReferenceType()
                         : dataProperty.IsNullable && requiredAttribute==null;
 
-                    schema.ReadOnly = dataProperty.IsReadOnly;
-                    schema.WriteOnly = dataProperty.IsWriteOnly;
                     schema.MinLength = modelType == typeof(string) && requiredAttribute is { AllowEmptyStrings: false } ? 1 : null;
+#endif
                 }
 
                 var defaultValueAttribute = customAttributes.OfType<DefaultValueAttribute>().FirstOrDefault();
@@ -392,7 +404,13 @@ private OpenApiSchema CreateObjectSchema(DataContract dataContract, SchemaReposi
                     ? GenerateSchemaForMember(dataProperty.MemberType, schemaRepository, dataProperty.MemberInfo, dataProperty)
                     : GenerateSchemaForType(dataProperty.MemberType, schemaRepository);
 
-                if ((dataProperty.IsRequired || customAttributes.OfType<RequiredAttribute>().Any())
+                if ((
+                    dataProperty.IsRequired
+                    || customAttributes.OfType<RequiredAttribute>().Any()
+#if NET7_0_OR_GREATER
+                    || customAttributes.OfType<System.Runtime.CompilerServices.RequiredMemberAttribute>().Any()
+#endif
+                    )
                     && !schema.Required.Contains(dataProperty.Name))
                 {
                     schema.Required.Add(dataProperty.Name);
diff --git a/src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/ApiParameterDescriptionExtensions.cs b/src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/ApiParameterDescriptionExtensions.cs
@@ -15,7 +15,10 @@ public static class ApiParameterDescriptionExtensions
         private static readonly Type[] RequiredAttributeTypes = new[]
         {
             typeof(BindRequiredAttribute),
-            typeof(RequiredAttribute)
+            typeof(RequiredAttribute),
+#if NET7_0_OR_GREATER
+            typeof(System.Runtime.CompilerServices.RequiredMemberAttribute)
+#endif
         };
 
         public static bool IsRequiredParameter(this ApiParameterDescription apiParameter)
@@ -109,4 +112,4 @@ internal static bool IsFromForm(this ApiParameterDescription apiParameter)
                 || (elementType != null && typeof(IFormFile).IsAssignableFrom(elementType));
         }
     }
-}
+}
diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/Fixtures/FakeController.cs b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/Fixtures/FakeController.cs
@@ -52,6 +52,16 @@ public void ActionWithIntParameterWithRequiredAttribute([Required]int param)
         public void ActionWithObjectParameter(XmlAnnotatedType param)
         { }
 
+#if NET7_0_OR_GREATER
+        public class TypeWithRequiredProperty
+        {
+            public required string RequiredProperty { get; set; }
+        }
+
+        public void ActionWithRequiredMember(TypeWithRequiredProperty param)
+        { }
+#endif
+
         [Consumes("application/someMediaType")]
         public void ActionWithConsumesAttribute(string param)
         { }
@@ -67,4 +77,4 @@ public int ActionWithProducesAttribute()
             throw new NotImplementedException();
         }
     }
-}
+}
diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs
@@ -1,20 +1,21 @@
 ﻿using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.ComponentModel.DataAnnotations;
 using System.Dynamic;
 using System.Linq;
+using System.Net;
 using System.Text.Json;
 using System.Text.Json.Serialization;
-using System.Net;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.ApiExplorer;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.AspNetCore.Routing.Constraints;
+using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Models;
-using Xunit;
 using Swashbuckle.AspNetCore.TestSupport;
-using Microsoft.OpenApi.Any;
+using Xunit;
 
 namespace Swashbuckle.AspNetCore.SwaggerGen.Test
 {
@@ -343,6 +344,43 @@ public void GenerateSchema_SetsReadOnlyAndWriteOnlyFlags_IfPropertyIsRestricted(
             Assert.True(schema.Properties["WriteOnlyProperty"].WriteOnly);
         }
 
+#if NET7_0_OR_GREATER
+        public class TypeWithRequiredProperty
+        {
+            public required string RequiredProperty { get; set; }
+        }
+
+        public class TypeWithRequiredPropertyAndValidationAttribute
+        {
+            [MinLength(1)]
+            public required string RequiredProperty { get; set; }
+        }
+
+        [Fact]
+        public void GenerateSchema_SetsRequired_IfPropertyHasRequiredKeyword()
+        {
+            var schemaRepository = new SchemaRepository();
+
+            var referenceSchema = Subject().GenerateSchema(typeof(TypeWithRequiredProperty), schemaRepository);
+
+            var schema = schemaRepository.Schemas[referenceSchema.Reference.Id];
+            Assert.Equal(new[] { "RequiredProperty" }, schema.Required.ToArray());
+        }
+
+        [Fact]
+        public void GenerateSchema_SetsRequired_IfPropertyHasRequiredKeywordAndValidationAttribute()
+        {
+            var schemaRepository = new SchemaRepository();
+
+            var referenceSchema = Subject().GenerateSchema(typeof(TypeWithRequiredPropertyAndValidationAttribute), schemaRepository);
+
+            var schema = schemaRepository.Schemas[referenceSchema.Reference.Id];
+            Assert.Equal(1, schema.Properties["RequiredProperty"].MinLength);
+            Assert.False(schema.Properties["RequiredProperty"].Nullable);
+            Assert.Equal(new[] { "RequiredProperty" }, schema.Required.ToArray());
+        }
+#endif
+
         [Theory]
         [InlineData(typeof(TypeWithParameterizedConstructor), nameof(TypeWithParameterizedConstructor.Id), false)]
         [InlineData(typeof(TypeWithParameterlessAndParameterizedConstructor), nameof(TypeWithParameterlessAndParameterizedConstructor.Id), true)]
diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGenerator/SwaggerGeneratorTests.cs b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGenerator/SwaggerGeneratorTests.cs
@@ -514,6 +514,38 @@ public void GetSwagger_SetsParameterRequired_IfActionParameterHasRequiredOrBindR
             Assert.Equal(expectedRequired, parameter.Required);
         }
 
+#if NET7_0_OR_GREATER
+        [Fact]
+        public void GetSwagger_SetsParameterRequired_IfActionParameterHasRequiredMember()
+        {
+            var subject = Subject(
+                apiDescriptions: new[]
+                {
+                    ApiDescriptionFactory.Create(
+                        methodInfo: typeof(FakeController).GetMethod(nameof(FakeController.ActionWithRequiredMember)),
+                        groupName: "v1",
+                        httpMethod: "POST",
+                        relativePath: "resource",
+                        parameterDescriptions: new []
+                        {
+                            new ApiParameterDescription
+                            {
+                                Name = "param",
+                                Source = BindingSource.Query,
+                                ModelMetadata = ModelMetadataFactory.CreateForProperty(typeof(FakeController.TypeWithRequiredProperty), "RequiredProperty")
+                            }
+                        })
+                }
+            );
+
+            var document = subject.GetSwagger("v1");
+
+            var operation = document.Paths["/resource"].Operations[OperationType.Post];
+            var parameter = Assert.Single(operation.Parameters);
+            Assert.True(parameter.Required);
+        }
+#endif
+
         [Theory]
         [InlineData(false)]
         [InlineData(true)]
diff --git a/test/Swashbuckle.AspNetCore.TestSupport/ApiExplorer/ApiDescriptionFactory.cs b/test/Swashbuckle.AspNetCore.TestSupport/ApiExplorer/ApiDescriptionFactory.cs
@@ -46,7 +46,7 @@ public static ApiDescription Create(
                         ControllerParameterDescriptor;
 #endif
 
-                    if (parameterDescriptorWithParameterInfo != null)
+                    if (parameterDescriptorWithParameterInfo != null && parameter.ModelMetadata == null)
                     {
                         parameter.ModelMetadata = ModelMetadataFactory.CreateForParameter(parameterDescriptorWithParameterInfo.ParameterInfo);
                     }

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,10 @@ public static class ApiParameterDescriptionExtensions`
`15`	`15`	`private static readonly Type[] RequiredAttributeTypes = new[]`
`16`	`16`	`{`
`17`	`17`	`typeof(BindRequiredAttribute),`
`18`		`- typeof(RequiredAttribute)`
	`18`	`+ typeof(RequiredAttribute),`
	`19`	`+#if NET7_0_OR_GREATER`
	`20`	`+ typeof(System.Runtime.CompilerServices.RequiredMemberAttribute)`
	`21`	`+#endif`
`19`	`22`	`};`
`20`	`23`
`21`	`24`	`public static bool IsRequiredParameter(this ApiParameterDescription apiParameter)`
`@@ -109,4 +112,4 @@ internal static bool IsFromForm(this ApiParameterDescription apiParameter)`
`109`	`112`	`\|\| (elementType != null && typeof(IFormFile).IsAssignableFrom(elementType));`
`110`	`113`	`}`
`111`	`114`	`}`
`112`		`-}`
	`115`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public static ApiDescription Create(`
`46`	`46`	`ControllerParameterDescriptor;`
`47`	`47`	`#endif`
`48`	`48`
`49`		`- if (parameterDescriptorWithParameterInfo != null)`
	`49`	`+ if (parameterDescriptorWithParameterInfo != null && parameter.ModelMetadata == null)`
`50`	`50`	`{`
`51`	`51`	`parameter.ModelMetadata = ModelMetadataFactory.CreateForParameter(parameterDescriptorWithParameterInfo.ParameterInfo);`
`52`	`52`	`}`