Support processing XML comments on [AsParameters] parameter

Author: captainsafia

src/OpenApi/gen/XmlCommentGenerator.Emitter.cs

@@ -57,6 +57,7 @@ namespace Microsoft.AspNetCore.OpenApi.Generated
     using System.Threading.Tasks;
     using Microsoft.AspNetCore.OpenApi;
     using Microsoft.AspNetCore.Mvc.Controllers;
+    using Microsoft.AspNetCore.Mvc.ModelBinding.Metadata;
     using Microsoft.Extensions.DependencyInjection;
     using Microsoft.OpenApi;
 
@@ -152,6 +153,30 @@ public static string CreateDocumentationId(this PropertyInfo property)
             return sb.ToString();
         }
 
+        /// <summary>
+        /// Generates a documentation comment ID for a property given its container type and property name.
+        /// Example: P:Namespace.ContainingType.PropertyName
+        /// </summary>
+        public static string CreateDocumentationId(Type containerType, string propertyName)
+        {
+            if (containerType == null)
+            {
+                throw new ArgumentNullException(nameof(containerType));
+            }
+            if (string.IsNullOrEmpty(propertyName))
+            {
+                throw new ArgumentException("Property name cannot be null or empty.", nameof(propertyName));
+            }
+
+            var sb = new StringBuilder();
+            sb.Append("P:");
+            sb.Append(GetTypeDocId(containerType, includeGenericArguments: false, omitGenericArity: false));
+            sb.Append('.');
+            sb.Append(propertyName);
+
+            return sb.ToString();
+        }
+
         /// <summary>
         /// Generates a documentation comment ID for a method (or constructor).
         /// For example:
@@ -416,6 +441,49 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform
                     }
                 }
             }
+            foreach (var parameterDescription in context.Description.ParameterDescriptions)
+            {
+                var metadata = parameterDescription.ModelMetadata;
+                if (metadata.MetadataKind == ModelMetadataKind.Property
+                    && metadata.ContainerType is { } containerType
+                    && metadata.PropertyName is { } propertyName)
+                {
+                    var propertyDocId = DocumentationCommentIdHelper.CreateDocumentationId(containerType, propertyName!);
+                    if (XmlCommentCache.Cache.TryGetValue(DocumentationCommentIdHelper.NormalizeDocId(propertyDocId), out var propertyComment))
+                    {
+                        var parameter = operation.Parameters?.SingleOrDefault(p => p.Name == metadata.Name);
+                        if (parameter is null)
+                        {
+                            if (operation.RequestBody is not null)
+                            {
+                                operation.RequestBody.Description = propertyComment.Summary ?? propertyComment.Description;
+                                if (propertyComment.Examples?.FirstOrDefault() is { } jsonString)
+                                {
+                                    var content = operation.RequestBody.Content?.Values;
+                                    if (content is null)
+                                    {
+                                        continue;
+                                    }
+                                    foreach (var mediaType in content)
+                                    {
+                                        mediaType.Example = jsonString.Parse();
+                                    }
+                                }
+                            }
+                            continue;
+                        }
+                        var targetOperationParameter = UnwrapOpenApiParameter(parameter);
+                        if (targetOperationParameter is not null)
+                        {
+                            targetOperationParameter.Description = propertyComment.Summary ?? propertyComment.Description;
+                            if (propertyComment.Examples?.FirstOrDefault() is { } jsonString)
+                            {
+                                targetOperationParameter.Example = jsonString.Parse();
+                            }
+                        }
+                    }
+                }
+            }
 
             return Task.CompletedTask;
         }

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/OperationTests.MinimalApis.cs

@@ -20,6 +20,7 @@ public async Task SupportsXmlCommentsOnOperationsFromMinimalApis()
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.AspNetCore.Http.HttpResults;
 using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
 
 var builder = WebApplication.CreateBuilder();
 
@@ -44,6 +45,9 @@ public async Task SupportsXmlCommentsOnOperationsFromMinimalApis()
 app.MapGet("/15", RouteHandlerExtensionMethods.Get15);
 app.MapPost("/16", RouteHandlerExtensionMethods.Post16);
 app.MapGet("/17", RouteHandlerExtensionMethods.Get17);
+app.MapPost("/18", RouteHandlerExtensionMethods.Post18);
+app.MapPost("/19", RouteHandlerExtensionMethods.Post19);
+app.MapGet("/20", RouteHandlerExtensionMethods.Get20);
 
 app.Run();
 
@@ -207,8 +211,70 @@ public static void Post16(Example example)
     public static int[][] Get17(int[] args)
     {
         return [[1, 2, 3], [4, 5, 6], [7, 8, 9], args];
+    }
 
+    /// <summary>
+    /// A summary of Post18.
+    /// </summary>
+    public static int Post18([AsParameters] FirstParameters queryParameters, [AsParameters] SecondParameters bodyParameters)
+    {
+        return 0;
     }
+
+    /// <summary>
+    /// Tests mixed regular and AsParameters with examples.
+    /// </summary>
+    /// <param name="regularParam">A regular parameter with documentation.</param>
+    /// <param name="mixedParams">Mixed parameter class with various types.</param>
+    public static IResult Post19(string regularParam, [AsParameters] MixedParametersClass mixedParams)
+    {
+        return TypedResults.Ok($"Regular: {regularParam}, Email: {mixedParams.Email}");
+    }
+
+    /// <summary>
+    /// Tests AsParameters with different binding sources.
+    /// </summary>
+    /// <param name="bindingParams">Parameters from different sources.</param>
+    public static IResult Get20([AsParameters] BindingSourceParametersClass bindingParams)
+    {
+        return TypedResults.Ok($"Query: {bindingParams.QueryParam}, Header: {bindingParams.HeaderParam}");
+    }
+}
+
+public class FirstParameters
+{
+    /// <summary>
+    /// The name of the person.
+    /// </summary>
+    public string? Name { get; set; }
+    /// <summary>
+    /// The age of the person.
+    /// </summary>
+    /// <example>30</example>
+    public int? Age { get; set; }
+    /// <summary>
+    /// The user information.
+    /// </summary>
+    /// <example>
+    /// {
+    ///   "username": "johndoe",
+    ///   "email": "[email protected]"
+    /// }
+    /// </example>
+    public User? User { get; set; }
+}
+
+public class SecondParameters
+{
+    /// <summary>
+    /// The description of the project.
+    /// </summary>
+    public string? Description { get; set; }
+    /// <summary>
+    /// The service used for testing.
+    /// </summary>
+    [FromServices]
+    public Example Service { get; set; }
 }
 
 public class User
@@ -232,6 +298,42 @@ public Example(Func<object?, int> function, object? state) : base(function, stat
     {
     }
 }
+
+public class MixedParametersClass
+{
+    /// <summary>
+    /// The user's email address.
+    /// </summary>
+    /// <example>"[email protected]"</example>
+    public string? Email { get; set; }
+
+    /// <summary>
+    /// The user's age in years.
+    /// </summary>
+    /// <example>25</example>
+    public int Age { get; set; }
+
+    /// <summary>
+    /// Whether the user is active.
+    /// </summary>
+    /// <example>true</example>
+    public bool IsActive { get; set; }
+}
+
+public class BindingSourceParametersClass
+{
+    /// <summary>
+    /// Query parameter from URL.
+    /// </summary>
+    [FromQuery]
+    public string? QueryParam { get; set; }
+
+    /// <summary>
+    /// Header value from request.
+    /// </summary>
+    [FromHeader]
+    public string? HeaderParam { get; set; }
+}
 """;
         var generator = new XmlCommentGenerator();
         await SnapshotTestHelper.Verify(source, generator, out var compilation);
@@ -304,6 +406,33 @@ await SnapshotTestHelper.VerifyOpenApi(compilation, document =>
 
             var path17 = document.Paths["/17"].Operations[HttpMethod.Get];
             Assert.Equal("A summary of Get17.", path17.Summary);
+
+            var path18 = document.Paths["/18"].Operations[HttpMethod.Post];
+            Assert.Equal("A summary of Post18.", path18.Summary);
+            Assert.Equal("The name of the person.", path18.Parameters[0].Description);
+            Assert.Equal("The age of the person.", path18.Parameters[1].Description);
+            Assert.Equal(30, path18.Parameters[1].Example.GetValue<int>());
+            Assert.Equal("The description of the project.", path18.Parameters[2].Description);
+            Assert.Equal("The user information.", path18.RequestBody.Description);
+            var path18RequestBody = path18.RequestBody.Content["application/json"];
+            var path18Example = Assert.IsAssignableFrom<JsonNode>(path18RequestBody.Example);
+            Assert.Equal("johndoe", path18Example["username"].GetValue<string>());
+            Assert.Equal("[email protected]", path18Example["email"].GetValue<string>());
+
+            var path19 = document.Paths["/19"].Operations[HttpMethod.Post];
+            Assert.Equal("Tests mixed regular and AsParameters with examples.", path19.Summary);
+            Assert.Equal("A regular parameter with documentation.", path19.Parameters[0].Description);
+            Assert.Equal("The user's email address.", path19.Parameters[1].Description);
+            Assert.Equal("[email protected]", path19.Parameters[1].Example.GetValue<string>());
+            Assert.Equal("The user's age in years.", path19.Parameters[2].Description);
+            Assert.Equal(25, path19.Parameters[2].Example.GetValue<int>());
+            Assert.Equal("Whether the user is active.", path19.Parameters[3].Description);
+            Assert.True(path19.Parameters[3].Example.GetValue<bool>());
+
+            var path20 = document.Paths["/20"].Operations[HttpMethod.Get];
+            Assert.Equal("Tests AsParameters with different binding sources.", path20.Summary);
+            Assert.Equal("Query parameter from URL.", path20.Parameters[0].Description);
+            Assert.Equal("Header value from request.", path20.Parameters[1].Description);
         });
     }
 }

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/snapshots/AddOpenApiTests.CanInterceptAddOpenApi#OpenApiXmlCommentSupport.generated.verified.cs

@@ -39,6 +39,7 @@ namespace Microsoft.AspNetCore.OpenApi.Generated
     using System.Threading.Tasks;
     using Microsoft.AspNetCore.OpenApi;
     using Microsoft.AspNetCore.Mvc.Controllers;
+    using Microsoft.AspNetCore.Mvc.ModelBinding.Metadata;
     using Microsoft.Extensions.DependencyInjection;
     using Microsoft.OpenApi;
 
@@ -134,6 +135,30 @@ public static string CreateDocumentationId(this PropertyInfo property)
             return sb.ToString();
         }
 
+        /// <summary>
+        /// Generates a documentation comment ID for a property given its container type and property name.
+        /// Example: P:Namespace.ContainingType.PropertyName
+        /// </summary>
+        public static string CreateDocumentationId(Type containerType, string propertyName)
+        {
+            if (containerType == null)
+            {
+                throw new ArgumentNullException(nameof(containerType));
+            }
+            if (string.IsNullOrEmpty(propertyName))
+            {
+                throw new ArgumentException("Property name cannot be null or empty.", nameof(propertyName));
+            }
+
+            var sb = new StringBuilder();
+            sb.Append("P:");
+            sb.Append(GetTypeDocId(containerType, includeGenericArguments: false, omitGenericArity: false));
+            sb.Append('.');
+            sb.Append(propertyName);
+
+            return sb.ToString();
+        }
+
         /// <summary>
         /// Generates a documentation comment ID for a method (or constructor).
         /// For example:
@@ -398,6 +423,49 @@ public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransform
                     }
                 }
             }
+            foreach (var parameterDescription in context.Description.ParameterDescriptions)
+            {
+                var metadata = parameterDescription.ModelMetadata;
+                if (metadata.MetadataKind == ModelMetadataKind.Property
+                    && metadata.ContainerType is { } containerType
+                    && metadata.PropertyName is { } propertyName)
+                {
+                    var propertyDocId = DocumentationCommentIdHelper.CreateDocumentationId(containerType, propertyName!);
+                    if (XmlCommentCache.Cache.TryGetValue(DocumentationCommentIdHelper.NormalizeDocId(propertyDocId), out var propertyComment))
+                    {
+                        var parameter = operation.Parameters?.SingleOrDefault(p => p.Name == metadata.Name);
+                        if (parameter is null)
+                        {
+                            if (operation.RequestBody is not null)
+                            {
+                                operation.RequestBody.Description = propertyComment.Summary ?? propertyComment.Description;
+                                if (propertyComment.Examples?.FirstOrDefault() is { } jsonString)
+                                {
+                                    var content = operation.RequestBody.Content?.Values;
+                                    if (content is null)
+                                    {
+                                        continue;
+                                    }
+                                    foreach (var mediaType in content)
+                                    {
+                                        mediaType.Example = jsonString.Parse();
+                                    }
+                                }
+                            }
+                            continue;
+                        }
+                        var targetOperationParameter = UnwrapOpenApiParameter(parameter);
+                        if (targetOperationParameter is not null)
+                        {
+                            targetOperationParameter.Description = propertyComment.Summary ?? propertyComment.Description;
+                            if (propertyComment.Examples?.FirstOrDefault() is { } jsonString)
+                            {
+                                targetOperationParameter.Example = jsonString.Parse();
+                            }
+                        }
+                    }
+                }
+            }
 
             return Task.CompletedTask;
         }
@@ -547,4 +615,4 @@ public static IServiceCollection AddOpenApi(this IServiceCollection services, st
         }
 
     }
-}
+}