Support .NET 10

- Add support for ASP.NET Core 10 and Microsoft.OpenApi v2.
- Add opt-in support for OpenAPI 3.1 when targeting `net10.0`.

Author: martincostello

.github/workflows/build.yml

@@ -53,6 +53,7 @@ jobs:
         dotnet-version: |
           6.0.x
           8.0.x
+          9.0.x
 
     - name: Setup .NET SDK
       uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
@@ -149,6 +150,7 @@ jobs:
     if: |
       github.event.repository.fork == false &&
       (github.ref_name == github.event.repository.default_branch ||
+       github.head_ref == 'dotnet-vnext' ||
        startsWith(github.ref, 'refs/tags/v'))
 
     environment:

Directory.Build.props

@@ -21,6 +21,8 @@
     TODO Fix warning from Swashbuckle.AspNetCore with dotnet pack
     -->
     <NoWarn>$(NoWarn);NU5128</NoWarn>
+    <!-- TODO Remove once .NET 10 is stable -->
+    <NoWarn>$(NoWarn);NU5104</NoWarn>
     <NuGetAuditMode>direct</NuGetAuditMode>
     <!--
     TODO Go through the code and add nullable annotations
@@ -39,7 +41,7 @@
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <UseArtifactsOutput>true</UseArtifactsOutput>
-    <VersionPrefix>8.1.0</VersionPrefix>
+    <VersionPrefix>9.0.0</VersionPrefix>
     <WarnOnPackingNonPackableProject>false</WarnOnPackingNonPackableProject>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(GITHUB_ACTIONS)' != '' AND '$(DEPENDABOT_JOB_ID)' == '' ">

Directory.Packages.props

@@ -34,4 +34,9 @@
     <PackageVersion Include="xunit.core" Version="2.9.3" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="3.0.2" />
   </ItemGroup>
+  <ItemGroup Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net10.0'))">
+    <PackageVersion Update="Microsoft.AspNetCore.OpenApi" Version="10.0.0-preview.1.25120.3" />
+    <PackageVersion Update="Microsoft.OpenApi" Version="2.0.0-preview5" />
+    <PackageVersion Update="Microsoft.OpenApi.Readers" Version="2.0.0-preview5" />
+  </ItemGroup>
 </Project>

global.json

@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "9.0.202",
+    "version": "10.0.100-preview.1.25120.13",
     "allowPrerelease": false,
     "rollForward": "latestMajor"
   }

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

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <IsPackable>false</IsPackable>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net8.0</TargetFramework>
+    <TargetFramework>net10.0</TargetFramework>
   </PropertyGroup>
   <ItemGroup>
     <Compile Include="..\..\src\Shared\JsonSchemaTypes.cs" Link="JsonSchemaTypes.cs" />

src/Shared/JsonExtensions.cs

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

src/Shared/JsonSchemaTypes.cs

@@ -1,12 +1,26 @@
+#if NET10_0_OR_GREATER
+using Microsoft.OpenApi.Models;
+#endif
+
 namespace Swashbuckle.AspNetCore;
 
 internal static class JsonSchemaTypes
 {
+#if NET10_0_OR_GREATER
+    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;
+#else
     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";
+#endif
 }

src/Swashbuckle.AspNetCore.Annotations/AnnotationsOperationFilter.cs

@@ -1,6 +1,12 @@
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
+#if NET10_0
+using OpenApiTag = Microsoft.OpenApi.Models.References.OpenApiTagReference;
+#else
+using OpenApiTag = Microsoft.OpenApi.Models.OpenApiTag;
+#endif
+
 namespace Swashbuckle.AspNetCore.Annotations;
 
 public class AnnotationsOperationFilter : IOperationFilter
@@ -71,7 +77,11 @@ private static void ApplySwaggerOperationAttribute(
 
         if (swaggerOperationAttribute.Tags is { } tags)
         {
+#if NET10_0_OR_GREATER
+            operation.Tags = [.. tags.Select(tagName => new OpenApiTag(tagName, null))];
+#else
             operation.Tags = [.. tags.Select(tagName => new OpenApiTag { Name = tagName })];
+#endif
         }
     }