Move from APIWeaver.OpenApi to OpenApi.Extensions (#197)

Author: Tsingis

src/Api/Api.csproj

@@ -1,11 +1,11 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <ItemGroup>
     <ProjectReference Include="..\Services\Services.csproj" />
-    <PackageReference Include="APIWeaver.OpenApi" />
     <PackageReference Include="Azure.Extensions.AspNetCore.Configuration.Secrets" />
     <PackageReference Include="Azure.Identity" />
     <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" />
     <PackageReference Include="DotNetEnv" />
+    <PackageReference Include="MartinCostello.OpenApi.Extensions" />
     <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" />
     <PackageReference Include="Microsoft.AspNetCore.OpenApi" />
     <PackageReference Include="Microsoft.Extensions.Logging.ApplicationInsights" />

src/Api/Setup/ApiServices.cs

@@ -1,8 +1,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 using System.Threading.RateLimiting;
-using APIWeaver;
 using Asp.Versioning;
+using MartinCostello.OpenApi;
 using Microsoft.AspNetCore.Http.Json;
 using Microsoft.AspNetCore.Server.Kestrel.Core;
 using Serilog;
@@ -42,8 +42,11 @@ public static void ConfigureServices(this IServiceCollection services)
             opt.OpenApiVersion = Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_0;
         });
 
-        services.AddApiWeaver(opt =>
+        services.AddOpenApiExtensions(opt =>
         {
+            opt.AddServerUrls = false;
+            opt.AddExamples = true;
+            opt.SerializationContexts.Add(DateOnlyJsonSerializerContext.Default);
             opt.AddExample<DateOnly, DateOnlyExampleProvider>();
         });
 

src/Api/Setup/DateOnlyExampleProvider.cs

@@ -1,8 +1,18 @@
-using APIWeaver;
+
+using System.Text.Json.Serialization;
+using MartinCostello.OpenApi;
 
 namespace Api.Setup;
 
 public sealed class DateOnlyExampleProvider : IExampleProvider<DateOnly>
 {
-    public static DateOnly GetExample() => DateOnly.FromDateTime(DateTime.UtcNow);
+    public static DateOnly GenerateExample() => DateOnly.FromDateTime(DateTime.UtcNow);
 }
+
+[JsonSerializable(typeof(DateOnly))]
+[JsonSourceGenerationOptions(
+    DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+    NumberHandling = JsonNumberHandling.Strict,
+    PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
+    WriteIndented = true)]
+public sealed partial class DateOnlyJsonSerializerContext : JsonSerializerContext;

src/Api/packages.lock.json

@@ -2,15 +2,6 @@
   "version": 2,
   "dependencies": {
     "net9.0": {
-      "APIWeaver.OpenApi": {
-        "type": "Direct",
-        "requested": "[2.7.0, )",
-        "resolved": "2.7.0",
-        "contentHash": "XrHa+EXyUyQ1y01/XdyEFBQbaQCJH2gpycUcKWIIkQq17T0k0mJ6DYhsOgV1nNlSuq2+LvbeM3o7H+Xr846W3g==",
-        "dependencies": {
-          "Microsoft.AspNetCore.OpenApi": "9.0.0"
-        }
-      },
       "Asp.Versioning.Mvc.ApiExplorer": {
         "type": "Direct",
         "requested": "[8.1.0, )",
@@ -56,6 +47,16 @@
           "System.Text.RegularExpressions": "4.3.1"
         }
       },
+      "MartinCostello.OpenApi.Extensions": {
+        "type": "Direct",
+        "requested": "[1.1.0, )",
+        "resolved": "1.1.0",
+        "contentHash": "xBkrm2YVSyb7dmFb+5ZFLl1O/bkqfjzqbIfS/hCAJBdWOEkmfnQHzMwO9qt9QiI1wd45VOtGUAwR+E35nwSjlQ==",
+        "dependencies": {
+          "Microsoft.AspNetCore.OpenApi": "9.0.0",
+          "Microsoft.OpenApi": "1.6.23"
+        }
+      },
       "Microsoft.ApplicationInsights.AspNetCore": {
         "type": "Direct",
         "requested": "[2.23.0, )",
@@ -573,8 +574,8 @@
       },
       "Microsoft.OpenApi": {
         "type": "Transitive",
-        "resolved": "1.6.17",
-        "contentHash": "Le+kehlmrlQfuDFUt1zZ2dVwrhFQtKREdKBo+rexOwaCoYP0/qpgT9tLxCsZjsgR5Itk1UKPcbgO+FyaNid/bA=="
+        "resolved": "1.6.23",
+        "contentHash": "tZ1I0KXnn98CWuV8cpI247A17jaY+ILS9vvF7yhI0uPPEqF4P1d7BWL5Uwtel10w9NucllHB3nTkfYTAcHAh8g=="
       },
       "Microsoft.Win32.Primitives": {
         "type": "Transitive",

src/Directory.Packages.props

@@ -4,11 +4,11 @@
     <CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
   </PropertyGroup>
   <ItemGroup>
-    <PackageVersion Include="APIWeaver.OpenApi" Version="2.7.0" />
     <PackageVersion Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.4.0" />
     <PackageVersion Include="Azure.Identity" Version="1.15.0" />
     <PackageVersion Include="Asp.Versioning.Mvc.ApiExplorer" Version="8.1.0" />
     <PackageVersion Include="DotNetEnv" Version="3.1.1" />
+    <PackageVersion Include="MartinCostello.OpenApi.Extensions" Version="1.1.0" />
     <PackageVersion Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.23.0" />
     <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="9.0.8" />
     <PackageVersion Include="Microsoft.AspNetCore.WebUtilities" Version="9.0.8" />

tests/IntegrationTests/packages.lock.json

@@ -68,14 +68,6 @@
           "xunit.v3.core": "[3.0.1]"
         }
       },
-      "APIWeaver.OpenApi": {
-        "type": "Transitive",
-        "resolved": "2.7.0",
-        "contentHash": "XrHa+EXyUyQ1y01/XdyEFBQbaQCJH2gpycUcKWIIkQq17T0k0mJ6DYhsOgV1nNlSuq2+LvbeM3o7H+Xr846W3g==",
-        "dependencies": {
-          "Microsoft.AspNetCore.OpenApi": "9.0.0"
-        }
-      },
       "Asp.Versioning.Abstractions": {
         "type": "Transitive",
         "resolved": "8.1.0",
@@ -176,6 +168,15 @@
         "resolved": "4.4.0",
         "contentHash": "gwJEfIGS7FhykvtZoscwXj/XwW+mJY6UbAZk+qtLKFUGWC95kfKXnj8VkxsZQnWBxJemM/q664rGLN5nf+OHZw=="
       },
+      "MartinCostello.OpenApi.Extensions": {
+        "type": "Transitive",
+        "resolved": "1.1.0",
+        "contentHash": "xBkrm2YVSyb7dmFb+5ZFLl1O/bkqfjzqbIfS/hCAJBdWOEkmfnQHzMwO9qt9QiI1wd45VOtGUAwR+E35nwSjlQ==",
+        "dependencies": {
+          "Microsoft.AspNetCore.OpenApi": "9.0.0",
+          "Microsoft.OpenApi": "1.6.23"
+        }
+      },
       "Microsoft.ApplicationInsights": {
         "type": "Transitive",
         "resolved": "2.23.0",
@@ -741,8 +742,8 @@
       },
       "Microsoft.OpenApi": {
         "type": "Transitive",
-        "resolved": "1.6.17",
-        "contentHash": "Le+kehlmrlQfuDFUt1zZ2dVwrhFQtKREdKBo+rexOwaCoYP0/qpgT9tLxCsZjsgR5Itk1UKPcbgO+FyaNid/bA=="
+        "resolved": "1.6.23",
+        "contentHash": "tZ1I0KXnn98CWuV8cpI247A17jaY+ILS9vvF7yhI0uPPEqF4P1d7BWL5Uwtel10w9NucllHB3nTkfYTAcHAh8g=="
       },
       "Microsoft.Testing.Extensions.TrxReport.Abstractions": {
         "type": "Transitive",
@@ -1947,11 +1948,11 @@
       "api": {
         "type": "Project",
         "dependencies": {
-          "APIWeaver.OpenApi": "[2.7.0, )",
           "Asp.Versioning.Mvc.ApiExplorer": "[8.1.0, )",
           "Azure.Extensions.AspNetCore.Configuration.Secrets": "[1.4.0, )",
           "Azure.Identity": "[1.15.0, )",
           "DotNetEnv": "[3.1.1, )",
+          "MartinCostello.OpenApi.Extensions": "[1.1.0, )",
           "Microsoft.ApplicationInsights.AspNetCore": "[2.23.0, )",
           "Microsoft.AspNetCore.OpenApi": "[9.0.8, )",
           "Microsoft.Extensions.Logging.ApplicationInsights": "[2.23.0, )",