Merge pull request #30 from Fresa/support-sequential-media-types

Support sequential media types

Author: Fresa

OpenAPI.WebApiGenerator.sln

@@ -34,6 +34,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{0AB3BF05
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Example.OpenApi", "tests\Example.OpenApi\Example.OpenApi.csproj", "{4E274740-E49C-4E56-9B69-C33D9409C119}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenAPI.WebApiGenerator.UnitTests", "tests\OpenAPI.WebApiGenerator.UnitTests\OpenAPI.WebApiGenerator.UnitTests.csproj", "{2CED6DCB-B934-438D-98F0-21C784B353EB}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{827E0CD3-B72D-47B6-A68D-7590B98EB39B}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -188,6 +192,18 @@ Global
 		{4E274740-E49C-4E56-9B69-C33D9409C119}.Release|x64.Build.0 = Release|Any CPU
 		{4E274740-E49C-4E56-9B69-C33D9409C119}.Release|x86.ActiveCfg = Release|Any CPU
 		{4E274740-E49C-4E56-9B69-C33D9409C119}.Release|x86.Build.0 = Release|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Debug|x64.Build.0 = Debug|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Debug|x86.Build.0 = Debug|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Release|x64.ActiveCfg = Release|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Release|x64.Build.0 = Release|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Release|x86.ActiveCfg = Release|Any CPU
+		{2CED6DCB-B934-438D-98F0-21C784B353EB}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

README.md

@@ -167,6 +167,26 @@ switch (request.TryMatchAcceptMediaType<Response.OK200>(out var matchedMediaType
 } 
 ```
 
+## Sequential Media Types
+OpenAPI 3.2 added support for [sequential media types](https://spec.openapis.org/oas/v3.2.0.html#sequential-media-types). The following sequential media types are supported for both request and response media content:
+- application/jsonl
+- application/x-ndjson
+- application/x-jsonlines
+- application/json-seq
+- application/geo+json-seq
+
+Other sequential media types can be implemented by simply following the expected naming convention and placing the implementations in the expected namespace, see the compilation error of any missing media type class.
+
+### Request Content 
+Inherit from `SequentialJsonEnumerable<T>` using the following naming convention:
+- application/jsonl (lower case) -> `ApplicationJsonlEnumerable<T>`
+
+### Response Content
+Inherit from `SequentialJsonWriter<T>` using the following naming convention:
+- application/jsonl (lower case) -> `ApplicationJsonlWriter<T>`
+
+See the [OpenAPI 3.2 examples](#examples) for further details how to consume and produce sequential media types.
+
 ## Authentication and Authorization
 OpenAPI defines [security scheme objects](https://spec.openapis.org/oas/latest#security-scheme-object) for authentication and authorization mechanisms. The generator implement endpoint filters that corresponds to the security declaration of each operation. Do _not_ call `UseAuthentication` or similar when configuring the application.
 

src/OpenAPI.WebApiGenerator/ApiGenerator.cs

@@ -89,9 +89,10 @@ private static void GenerateCode(SourceProductionContext context,
 
         var validationExtensionsGenerator = new ValidationExtensionsGenerator(rootNamespace);
         validationExtensionsGenerator.GenerateClass().AddTo(context);
+        var sequentialJsonEnumeratorsGenerator = new SequentialMediaTypesGenerator(rootNamespace);
+        sequentialJsonEnumeratorsGenerator.GenerateClasses().AddTo(context);
 
         var operations = new List<(string Namespace, KeyValuePair<HttpMethod, OpenApiOperation> Operation)>();
-        var securityParameterGenerators = new ConcurrentDictionary<IOpenApiSecurityScheme, List<ParameterGenerator>>();
         foreach (var path in openApi.Paths)
         {
             var pathExpression = path.Key;
@@ -137,9 +138,10 @@ private static void GenerateCode(SourceProductionContext context,
                         var schemaReference = openApiOperationVisitor.GetSchemaReference(mediaType);
                         var typeDeclaration = schemaGenerator.Generate(schemaReference);
                         return new RequestBodyContentGenerator(
-                            pair.Key,
+                            pair,
                             typeDeclaration,
-                            httpRequestExtensionsGenerator);
+                            httpRequestExtensionsGenerator,
+                            sequentialJsonEnumeratorsGenerator);
                     }).ToList();
                     requestBodyGenerator = new RequestBodyGenerator(
                         body,
@@ -164,14 +166,14 @@ private static void GenerateCode(SourceProductionContext context,
                     var responseContent =
                         // OpenAPI.NET is incorrectly adding content where there is none defined. 
                         // No content definition means NO content.
-                        response.Content?.Where(content => 
-                            openApiResponseVisitor.HasContent(content.Value)) ?? [];
-                    var responseBodyGenerators = responseContent.Select(valuePair =>
+                        response.Content?.Where(responseContent => 
+                            openApiResponseVisitor.HasContent(responseContent.Value)) ?? [];
+                    var responseBodyGenerators = responseContent.Select(mediaContent =>
                     {
-                        var content = valuePair.Value;
-                        var contentSchemaReference = openApiResponseVisitor.GetSchemaReference(content);
+                        var contentMediaType = mediaContent.Value;
+                        var contentSchemaReference = openApiResponseVisitor.GetSchemaReference(contentMediaType);
                         var typeDeclaration = schemaGenerator.Generate(contentSchemaReference);
-                        return new ResponseBodyContentGenerator(valuePair.Key, typeDeclaration);
+                        return new ResponseBodyContentGenerator(mediaContent, typeDeclaration);
                     }).ToList();
 
                     var responseHeaderGenerators = response.Headers?.Select(valuePair =>

src/OpenAPI.WebApiGenerator/CodeGeneration/AuthGenerator.cs

@@ -262,7 +262,7 @@ internal abstract class BaseSecurityRequirementsFilter(WebApiConfiguration confi
                     break;
                 } 
              
-                authorized &= ClaimContainsScopes(authenticateResult.Principal, configuration.SecuritySchemeOptions.GetScopeOptions(scheme), scopes);
+                authorized &= ClaimContainsScopes(authenticateResult.Principal, Configuration.SecuritySchemeOptions.GetScopeOptions(scheme), scopes);
                 if (!authorized)
                     break;
             }

src/OpenAPI.WebApiGenerator/CodeGeneration/OperationGenerator.cs

@@ -68,6 +68,18 @@ internal partial class Operation
     private Func<Request, ImmutableList<ValidationResult>, Response> HandleRequestValidationError { get; } = (_, validationResult) => 
         {{jsonValidationExceptionGenerator.CreateThrowJsonValidationExceptionInvocation("Request is not valid", "validationResult")}};
 
+    /// <summary>
+    /// Create a request validation error response.
+    /// <exception cref="JsonValidationException"></exception>
+    /// <param name="request">The invalid request</param>
+    /// <param name="ValidationContext">The validation context describing the validation errors</param>
+    /// </summary>
+    private Response CreateRequestValidationErrorResponse(Request request, ValidationContext validationContext)
+    {
+        var configuration = request.HttpContext.RequestServices.GetRequiredService<WebApiConfiguration>();
+        return HandleRequestValidationError(request, validationContext.Results.WithLocation(configuration.OpenApiSpecificationUri));
+    }
+    
 {{authGenerator.GenerateAuthFilters(operation.Operation, parameters, out var requiresAuth).Indent(4)}}
 {{(requiresAuth ? 
 """

src/OpenAPI.WebApiGenerator/CodeGeneration/RequestBodyContentGenerator.cs

@@ -1,39 +1,51 @@
-using System.Net.Http.Headers;
+using System.Collections.Generic;
+using System.Net.Http.Headers;
 using Corvus.Json.CodeGeneration;
 using Corvus.Json.CodeGeneration.CSharp;
+using Microsoft.OpenApi;
 using OpenAPI.WebApiGenerator.Extensions;
 
 namespace OpenAPI.WebApiGenerator.CodeGeneration;
 
 internal sealed class RequestBodyContentGenerator(
-    string contentType, 
+    KeyValuePair<string, IOpenApiMediaType> contentMediaType, 
     TypeDeclaration typeDeclaration,
-    HttpRequestExtensionsGenerator httpRequestExtensionsGenerator)
+    HttpRequestExtensionsGenerator httpRequestExtensionsGenerator,
+    SequentialMediaTypesGenerator sequentialMediaTypesGenerator)
 {
-    private string FullyQualifiedTypeName =>
-        $"{FullyQualifiedTypeDeclarationIdentifier}?";
-
     private string FullyQualifiedTypeDeclarationIdentifier => typeDeclaration.FullyQualifiedDotnetTypeName();
-
-    internal string PropertyName { get; } = contentType.ToPascalCase();
-
-    internal MediaTypeWithQualityHeaderValue ContentType { get; } = MediaTypeWithQualityHeaderValue.Parse(contentType);
+    private readonly bool _isSequentialMediaType = contentMediaType.Value.ItemSchema != null;
+    
+    internal string PropertyName { get; } = contentMediaType.Key.ToPascalCase();
+    internal bool IsPropertyStruct => !_isSequentialMediaType; 
+    
+    internal MediaTypeWithQualityHeaderValue ContentType { get; } = MediaTypeWithQualityHeaderValue.Parse(contentMediaType.Key);
 
     internal string SchemaLocation => typeDeclaration.RelativeSchemaLocation;
     internal string GenerateRequestBindingDirective() =>
 $"""
-{PropertyName} = 
-    ({httpRequestExtensionsGenerator.CreateBindBodyInvocation(
-            "request", 
-            FullyQualifiedTypeDeclarationIdentifier)
-        .Indent(8).Trim()})
+{PropertyName} = {(_isSequentialMediaType ?
+    $"{sequentialMediaTypesGenerator.GenerateConstructorInstance(
+        ContentType,
+        typeDeclaration, 
+        "request.Body")}" : 
+    $"({httpRequestExtensionsGenerator.CreateBindBodyInvocation(
+        "request", 
+        FullyQualifiedTypeDeclarationIdentifier).Indent(8).Trim()})")}
 """;
+    
 
-    public string GenerateRequestProperty() =>
-        $$"""
-          /// <summary>
-          /// Request content for {{contentType}}
-          /// </summary>
-          internal {{FullyQualifiedTypeName}} {{PropertyName}} { get; private set; }
-          """;
+    public string GenerateRequestProperty()
+    {
+        var fullyQualifiedTypeName = _isSequentialMediaType
+            ? sequentialMediaTypesGenerator.GetFullyQualifiedTypeName(ContentType, typeDeclaration)
+            : FullyQualifiedTypeDeclarationIdentifier;
+        return 
+$$"""
+/// <summary>
+/// Request content for {{contentMediaType.Key}}
+/// </summary>
+internal {{fullyQualifiedTypeName}}? {{PropertyName}} { get; private set; }
+""";
+    }
 }

src/OpenAPI.WebApiGenerator/CodeGeneration/RequestBodyGenerator.cs

@@ -120,7 +120,7 @@ internal ValidationContext Validate(ValidationContext validationContext, Validat
         {{{_contentGenerators.AggregateToString(content => 
 $"""
             true when {content.PropertyName} is not null =>
-                {content.PropertyName}!.Value.Validate("{content.SchemaLocation}", true, validationContext, validationLevel),
+                {content.PropertyName}!.{(content.IsPropertyStruct ? "Value." : "")}Validate("{content.SchemaLocation}", true, validationContext, validationLevel),
 """)}} 
             true when requestContentType is null =>
                 {{(_body.Required ? """validationContext.WithResult(false, "Request content is missing")""" : "validationContext")}},