Use OpenAPI package

Migrate from NSwag to the new Microsoft.AspNetCore.OpenApi NuGet package.
martincostello · Jul 2, 2024 · aa64487 · aa64487
1 parent e2e3314
commit aa64487
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/src/TodoApp/Program.cs b/src/TodoApp/Program.cs
@@ -17,11 +17,14 @@
 builder.Services.AddRazorPages();
 
 // Configure OpenAPI documentation for the Todo API
-builder.Services.AddEndpointsApiExplorer();
-builder.Services.AddOpenApiDocument(options =>
+builder.Services.AddOpenApi(options =>
 {
-    options.Title = "Todo API";
-    options.Version = "v1";
+    options.UseTransformer((document, _, _) =>
+    {
+        document.Info.Title = "Todo API";
+        document.Info.Version = "v1";
+        return Task.CompletedTask;
+    });
 });
 
 if (string.Equals(builder.Configuration["CODESPACES"], "true", StringComparison.OrdinalIgnoreCase))
@@ -57,7 +60,7 @@
 app.UseAuthorization();
 
 // Add endpoint for OpenAPI
-app.UseOpenApi();
+app.MapOpenApi();
 
 // Add the HTTP endpoints
 app.MapAuthenticationRoutes();

diff --git a/src/TodoApp/TodoApp.csproj b/src/TodoApp/TodoApp.csproj
@@ -11,9 +11,9 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="AspNet.Security.OAuth.GitHub" Version="8.1.0" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0-preview.5.24306.11" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="9.0.0-preview.5.24306.3" />
     <PackageReference Include="Microsoft.TypeScript.MSBuild" Version="5.5.3" PrivateAssets="all" />
-    <PackageReference Include="NSwag.AspNetCore" Version="14.0.8" />
   </ItemGroup>
   <ItemGroup>
     <Content Update="package.json;package-lock.json;tsconfig.json" CopyToPublishDirectory="Never" />

diff --git a/src/TodoApp/wwwroot/swagger-ui/index.html b/src/TodoApp/wwwroot/swagger-ui/index.html
@@ -32,7 +32,7 @@
     <script>
         window.onload = function () {
             window.ui = SwaggerUIBundle({
-                url: "/swagger/v1/swagger.json",
+                url: "/openapi/v1.json",
                 dom_id: '#swagger-ui',
                 deepLinking: true,
                 presets: [