Support .NET 10

.github/dependabot.yml

@@ -43,5 +43,5 @@ updates:
     - dependency-name: "Microsoft.AspNetCore.Mvc.NewtonsoftJson"
     - dependency-name: "Microsoft.AspNetCore.Mvc.Testing"
     - dependency-name: "Microsoft.OpenApi"
-    - dependency-name: "Microsoft.OpenApi.Readers"
+    - dependency-name: "Microsoft.OpenApi.YamlReader"
     - dependency-name: "xunit"

Directory.Build.props

@@ -8,7 +8,7 @@
     <Company>https://github.com/domaindrivendev/Swashbuckle.AspNetCore</Company>
     <ContinuousIntegrationBuild Condition=" '$(CI)' != '' ">true</ContinuousIntegrationBuild>
     <Copyright>Copyright (c) 2016-$([System.DateTime]::Now.ToString(yyyy)) Richard Morris</Copyright>
-    <DefaultTargetFrameworks>net9.0;net8.0</DefaultTargetFrameworks>
+    <DefaultTargetFrameworks>net10.0;net9.0;net8.0</DefaultTargetFrameworks>
     <Deterministic>true</Deterministic>
     <EmbedUntrackedSources>true</EmbedUntrackedSources>
     <EnablePackageValidation>$(IsPackable)</EnablePackageValidation>
@@ -18,6 +18,8 @@
     <LangVersion>latest</LangVersion>
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
     <NeutralLanguage>en-US</NeutralLanguage>
+    <!-- TODO Remove once .NET 10 is stable -->
+    <NoWarn>$(NoWarn);NU5104</NoWarn>
     <NuGetAuditMode>direct</NuGetAuditMode>
     <!--
     TODO Go through the code and add nullable annotations
@@ -37,7 +39,7 @@
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <UseArtifactsOutput>true</UseArtifactsOutput>
-    <VersionPrefix>9.0.4</VersionPrefix>
+    <VersionPrefix>10.0.0</VersionPrefix>
     <WarnOnPackingNonPackableProject>false</WarnOnPackingNonPackableProject>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(GITHUB_ACTIONS)' != '' AND '$(DEPENDABOT_JOB_ID)' == '' ">

Directory.Packages.props

@@ -12,11 +12,11 @@
     <PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="8.0.17" />
     <PackageVersion Include="Microsoft.AspNetCore.Mvc.Versioning" Version="5.1.0" />
     <PackageVersion Include="Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer" Version="5.1.0" />
-    <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="8.0.17" />
+    <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="10.0.0-preview.5.25277.114" />
     <PackageVersion Include="Microsoft.AspNetCore.TestHost" Version="8.0.17" />
     <PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="4.14.0" />
-    <PackageVersion Include="Microsoft.OpenApi" Version="1.6.23" />
-    <PackageVersion Include="Microsoft.OpenApi.Readers" Version="1.6.23" />
+    <PackageVersion Include="Microsoft.OpenApi" Version="2.0.0-preview.18" />
+    <PackageVersion Include="Microsoft.OpenApi.YamlReader" Version="2.0.0-preview.18" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageVersion Include="NSubstitute" Version="5.3.0" />

README.md

@@ -28,7 +28,7 @@ for more details.
 
 | Swashbuckle Version | ASP.NET Core | Swagger/OpenAPI Spec. | swagger-ui | Redoc |
 |----------|----------|----------|----------|----------|
-| [CI](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/commits/master/) | >= 8.0.0 | 2.0, 3.0 | [5.x.x](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/src/Swashbuckle.AspNetCore.SwaggerUI/package.json#L6) | [2.x.x](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/src/Swashbuckle.AspNetCore.ReDoc/package.json#L6) |
+| [CI](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/commits/master/) | >= 8.0.0 | 2.0, 3.0, 3.1 | [5.x.x](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/src/Swashbuckle.AspNetCore.SwaggerUI/package.json#L6) | [2.x.x](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/src/Swashbuckle.AspNetCore.ReDoc/package.json#L6) |
 | [9.0.3](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/v9.0.3) | >= 8.0.0 | 2.0, 3.0 | [5.26.2](https://github.com/swagger-api/swagger-ui/releases/tag/v5.26.2) | [2.5.0](https://github.com/Redocly/redoc/releases/tag/v2.5.0) |
 | [8.1.4](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/v8.1.4) | >= 8.0.0, 2.3.x | 2.0, 3.0 | [5.22.0](https://github.com/swagger-api/swagger-ui/releases/tag/v5.22.0) | [2.5.0](https://github.com/Redocly/redoc/releases/tag/v2.5.0) |
 | [7.3.2](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/v7.3.2) | >= 8.0.0, 6.0.x, 2.1.x | 2.0, 3.0 | [5.20.1](https://github.com/swagger-api/swagger-ui/releases/tag/v5.20.1) | [2.4.0](https://github.com/Redocly/redoc/releases/tag/v2.4.0) |

docs/configure-and-customize-annotations.md

@@ -129,7 +129,7 @@ public class Product
 ```csharp
 public class ProductSchemaFilter : ISchemaFilter
 {
-    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
+    public void Apply(IOpenApiSchema schema, SchemaFilterContext context)
     {
         schema.Example = new OpenApiObject
         {

docs/configure-and-customize-swaggergen.md

@@ -672,11 +672,12 @@ to inform the AutoRest tool how enums should be modelled when it generates the A
 ```csharp
 public class AutoRestSchemaFilter : ISchemaFilter
 {
-    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
+    public void Apply(IOpenApiSchema schema, SchemaFilterContext context)
     {
         var type = context.Type;
         if (type.IsEnum)
         {
+            schema.Extensions ??= [];
             schema.Extensions.Add(
                 "x-ms-enum",
                 new OpenApiObject
@@ -708,7 +709,7 @@ so you will need [a special JsonConverter, as shown in the .NET documentation](h
 ```csharp
 public class DictionaryTKeyEnumTValueSchemaFilter : ISchemaFilter
 {
-  public void Apply(OpenApiSchema schema, SchemaFilterContext context)
+  public void Apply(IOpenApiSchema schema, SchemaFilterContext context)
   {
     // Only run for fields that are a Dictionary<Enum, TValue>
     if (!context.Type.IsGenericType || !context.Type.GetGenericTypeDefinition().IsAssignableFrom(typeof(Dictionary<,>)))

global.json

@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "9.0.302",
+    "version": "10.0.100-preview.5.25277.114",
     "allowPrerelease": false,
     "rollForward": "latestMajor",
     "paths": [ ".dotnet", "$host$" ]

perf/Swashbuckle.AspNetCore.Benchmarks/Swashbuckle.AspNetCore.Benchmarks.csproj

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <IsPackable>false</IsPackable>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net9.0</TargetFramework>
+    <TargetFramework>net10.0</TargetFramework>
     <SignAssembly>True</SignAssembly>
     <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)..\..\src\Swashbuckle.AspNetCore.Swagger\Swashbuckle.AspNetCore.Swagger.snk</AssemblyOriginatorKeyFile>
   </PropertyGroup>

perf/Swashbuckle.AspNetCore.Benchmarks/XmlCommentsBenchmark.cs

@@ -57,7 +57,9 @@ public void Setup()
         using var xmlStream = new MemoryStream();
         xmlDocument.Save(xmlStream);
         xmlStream.Seek(0, SeekOrigin.Begin);
+
         var xPathDocument = new XPathDocument(xmlStream);
+        var members = XmlCommentsDocumentHelper.CreateMemberDictionary(xPathDocument);
 
         // Document
         _document = new OpenApiDocument();
@@ -83,21 +85,21 @@ public void Setup()
             null,
             null);
 
-        _documentFilter = new XmlCommentsDocumentFilter(xPathDocument);
+        _documentFilter = new XmlCommentsDocumentFilter(members, new());
 
         // Operation
         _operation = new OpenApiOperation();
         var methodInfo = typeof(FakeConstructedControllerWithXmlComments)
             .GetMethod(nameof(FakeConstructedControllerWithXmlComments.ActionWithSummaryAndResponseTags));
 
         var apiDescription = ApiDescriptionFactory.Create(methodInfo: methodInfo, groupName: "v1", httpMethod: "POST", relativePath: "resource");
-        _operationFilterContext = new OperationFilterContext(apiDescription, null, null, methodInfo);
-        _operationFilter = new XmlCommentsOperationFilter(xPathDocument);
+        _operationFilterContext = new OperationFilterContext(apiDescription, null, null, null, methodInfo);
+        _operationFilter = new XmlCommentsOperationFilter(members, new());
 
         // Parameter
         _parameter = new()
         {
-            Schema = new()
+            Schema = new OpenApiSchema()
             {
                 Type = JsonSchemaTypes.String,
                 Description = "schema-level description",
@@ -106,8 +108,9 @@ public void Setup()
 
         var propertyInfo = typeof(XmlAnnotatedType).GetProperty(nameof(XmlAnnotatedType.StringProperty));
         var apiParameterDescription = new ApiParameterDescription();
-        _parameterFilterContext = new ParameterFilterContext(apiParameterDescription, null, null, propertyInfo: propertyInfo);
-        _parameterFilter = new XmlCommentsParameterFilter(xPathDocument);
+        var xmlDocMembers = XmlCommentsDocumentHelper.CreateMemberDictionary(xPathDocument);
+        _parameterFilterContext = new ParameterFilterContext(apiParameterDescription, null, null, null, propertyInfo: propertyInfo);
+        _parameterFilter = new XmlCommentsParameterFilter(xmlDocMembers, new());
 
         // Request Body
         _requestBody = new OpenApiRequestBody
@@ -116,7 +119,7 @@ public void Setup()
             {
                 ["application/json"] = new()
                 {
-                    Schema = new()
+                    Schema = new OpenApiSchema()
                     {
                         Type = JsonSchemaTypes.String,
                     },
@@ -131,8 +134,8 @@ public void Setup()
         {
             ParameterDescriptor = new ControllerParameterDescriptor { ParameterInfo = parameterInfo }
         };
-        _requestBodyFilterContext = new RequestBodyFilterContext(bodyParameterDescription, null, null, null);
-        _requestBodyFilter = new XmlCommentsRequestBodyFilter(xPathDocument);
+        _requestBodyFilterContext = new RequestBodyFilterContext(bodyParameterDescription, null, null, null, null);
+        _requestBodyFilter = new XmlCommentsRequestBodyFilter(xmlDocMembers, new());
     }
 
     [Benchmark]

src/Shared/JsonExtensions.cs

@@ -0,0 +1,26 @@
+using System.Text.Json;
+using System.Text.Json.Nodes;
+
+namespace Swashbuckle.AspNetCore;
+
+internal static class JsonExtensions
+{
+    private static readonly JsonSerializerOptions Options = new()
+    {
+#if NET9_0_OR_GREATER
+        NewLine = "\n",
+#endif
+        WriteIndented = true,
+    };
+
+    public static string ToJson(this JsonNode value)
+    {
+        var json = value.ToJsonString(Options);
+
+#if !NET9_0_OR_GREATER
+        json = json.Replace("\r\n", "\n");
+#endif
+
+        return json;
+    }
+}

src/Shared/JsonSchemaTypes.cs

@@ -1,12 +1,14 @@
+using Microsoft.OpenApi.Models;
+
 namespace Swashbuckle.AspNetCore;
 
 internal static class JsonSchemaTypes
 {
-    public const string Array = "array";
-    public const string Boolean = "boolean";
-    public const string Integer = "integer";
-    public const string Number = "number";
-    public const string Null = "null";
-    public const string Object = "object";
-    public const string String = "string";
+    public static readonly JsonSchemaType Array = JsonSchemaType.Array;
+    public static readonly JsonSchemaType Boolean = JsonSchemaType.Boolean;
+    public static readonly JsonSchemaType Integer = JsonSchemaType.Integer;
+    public static readonly JsonSchemaType Number = JsonSchemaType.Number;
+    public static readonly JsonSchemaType Null = JsonSchemaType.Null;
+    public static readonly JsonSchemaType Object = JsonSchemaType.Object;
+    public static readonly JsonSchemaType String = JsonSchemaType.String;
 }

src/Swashbuckle.AspNetCore.Annotations/AnnotationsDocumentFilter.cs

@@ -24,26 +24,32 @@ public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
     }
 
     private static void ApplySwaggerTagAttribute(
-        OpenApiDocument swaggerDoc,
+        OpenApiDocument document,
         string controllerName,
         IEnumerable<object> customAttributes)
     {
         var swaggerTagAttribute = customAttributes
             .OfType<SwaggerTagAttribute>()
             .FirstOrDefault();
 
-        if (swaggerTagAttribute == null)
+        if (swaggerTagAttribute is null)
         {
             return;
         }
 
-        swaggerDoc.Tags.Add(new OpenApiTag
+        var tag = document.Tags.FirstOrDefault((p) => p?.Name == controllerName);
+
+        if (tag is null)
+        {
+            tag = new() { Name = controllerName };
+            document.Tags.Add(tag);
+        }
+
+        tag.Description ??= swaggerTagAttribute.Description;
+
+        if (swaggerTagAttribute.ExternalDocsUrl is { } url)
         {
-            Name = controllerName,
-            Description = swaggerTagAttribute.Description,
-            ExternalDocs = (swaggerTagAttribute.ExternalDocsUrl != null)
-                ? new OpenApiExternalDocs { Url = new Uri(swaggerTagAttribute.ExternalDocsUrl) }
-                : null
-        });
+            tag.ExternalDocs ??= new OpenApiExternalDocs { Url = new(url) };
+        }
     }
 }

src/Swashbuckle.AspNetCore.Annotations/AnnotationsOperationFilter.cs

@@ -1,4 +1,5 @@
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.References;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
 namespace Swashbuckle.AspNetCore.Annotations;
@@ -69,7 +70,7 @@ private static void ApplySwaggerOperationAttribute(
 
         if (swaggerOperationAttribute.Tags is { } tags)
         {
-            operation.Tags = [.. tags.Select(tagName => new OpenApiTag { Name = tagName })];
+            operation.Tags = [.. tags.Select(tagName => new OpenApiTagReference(tagName))];
         }
     }
 
@@ -113,17 +114,19 @@ private static void ApplySwaggerResponseAttributes(
 
             operation.Responses[statusCode] = response;
 
-            if (swaggerResponseAttribute.ContentTypes is { } contentTypes)
+            if (response is OpenApiResponse concrete &&
+                swaggerResponseAttribute.ContentTypes is { } contentTypes)
             {
-                response.Content.Clear();
+                concrete.Content?.Clear();
+                concrete.Content ??= [];
 
                 foreach (var contentType in contentTypes)
                 {
                     var schema = (swaggerResponseAttribute.Type != null && swaggerResponseAttribute.Type != typeof(void))
                         ? context.SchemaGenerator.GenerateSchema(swaggerResponseAttribute.Type, context.SchemaRepository)
                         : null;
 
-                    response.Content.Add(contentType, new OpenApiMediaType { Schema = schema });
+                    concrete.Content.Add(contentType, new OpenApiMediaType { Schema = schema });
                 }
             }
         }

src/Swashbuckle.AspNetCore.Annotations/AnnotationsParameterFilter.cs

@@ -1,24 +1,26 @@
 using System.Reflection;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.Interfaces;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
 namespace Swashbuckle.AspNetCore.Annotations;
 
 public class AnnotationsParameterFilter : IParameterFilter
 {
-    public void Apply(OpenApiParameter parameter, ParameterFilterContext context)
+    public void Apply(IOpenApiParameter parameter, ParameterFilterContext context)
     {
-        if (context.PropertyInfo != null)
+        if (context.PropertyInfo is { } propertyInfo)
         {
-            ApplyPropertyAnnotations(parameter, context.PropertyInfo);
+            ApplyPropertyAnnotations(parameter, propertyInfo);
         }
-        else if (context.ParameterInfo != null)
+
+        if (context.ParameterInfo is { } parameterInfo)
         {
-            ApplyParamAnnotations(parameter, context.ParameterInfo);
+            ApplyParamAnnotations(parameter, parameterInfo);
         }
     }
 
-    private static void ApplyPropertyAnnotations(OpenApiParameter parameter, PropertyInfo propertyInfo)
+    private static void ApplyPropertyAnnotations(IOpenApiParameter parameter, PropertyInfo propertyInfo)
     {
         var swaggerParameterAttribute = propertyInfo.GetCustomAttributes<SwaggerParameterAttribute>()
             .FirstOrDefault();
@@ -29,7 +31,7 @@ private static void ApplyPropertyAnnotations(OpenApiParameter parameter, Propert
         }
     }
 
-    private static void ApplyParamAnnotations(OpenApiParameter parameter, ParameterInfo parameterInfo)
+    private static void ApplyParamAnnotations(IOpenApiParameter parameter, ParameterInfo parameterInfo)
     {
         var swaggerParameterAttribute = parameterInfo.GetCustomAttribute<SwaggerParameterAttribute>();
 
@@ -39,7 +41,7 @@ private static void ApplyParamAnnotations(OpenApiParameter parameter, ParameterI
         }
     }
 
-    private static void ApplySwaggerParameterAttribute(OpenApiParameter parameter, SwaggerParameterAttribute swaggerParameterAttribute)
+    private static void ApplySwaggerParameterAttribute(IOpenApiParameter parameter, SwaggerParameterAttribute swaggerParameterAttribute)
     {
         if (swaggerParameterAttribute.Description is { } description)
         {