Use new open api and scalar

davidfowl · Nov 15, 2024 · 1449c43 · 1449c43
1 parent 3530e8a
commit 1449c43
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 53 deletions.
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -13,25 +13,24 @@
   <ItemGroup>
     <PackageVersion Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="9.0.0" />
     <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
-    <PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.0" PrivateAssets="all" />
+    <PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.0" />
     <PackageVersion Include="Microsoft.EntityFrameworkCore.Sqlite" Version="9.0.0" />
-    <PackageVersion Include="Microsoft.NET.Build.Containers" Version="9.0.0" />
     <PackageVersion Include="Microsoft.OpenApi" Version="1.6.17" />
     <PackageVersion Include="MiniValidation" Version="0.9.0" />
-    <PackageVersion Include="Swashbuckle.AspNetCore" Version="6.5.0" />
     <PackageVersion Include="AspNet.Security.OAuth.GitHub" Version="9.0.0" />
     <PackageVersion Include="Auth0.AspNetCore.Authentication" Version="1.4.1" />
     <PackageVersion Include="Microsoft.AspNetCore.Authentication.Google" Version="9.0.0" />
     <PackageVersion Include="Microsoft.AspNetCore.Authentication.MicrosoftAccount" Version="9.0.0" />
     <PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.Server" Version="9.0.0" />
     <PackageVersion Include="Yarp.ReverseProxy" Version="2.2.0" />
     <PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly" Version="9.0.0" />
-    <PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="9.0.0" PrivateAssets="all" />
+    <PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="9.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Http" Version="9.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Http.Resilience" Version="9.0.0" />
     <PackageVersion Include="Microsoft.Extensions.ServiceDiscovery" Version="9.0.0" />
     <PackageVersion Include="Microsoft.Extensions.ServiceDiscovery.Yarp" Version="9.0.0" />
     <PackageVersion Include="Aspire.Hosting.AppHost" Version="9.0.0" />
+	<PackageVersion Include="Scalar.AspNetCore" Version="1.2.37" />
   </ItemGroup>
   <!-- OpenTelemetry -->
   <ItemGroup>

diff --git a/TodoApi/Extensions/OpenApiExtensions.cs b/TodoApi/Extensions/OpenApiExtensions.cs
diff --git a/TodoApi/Program.cs b/TodoApi/Program.cs
@@ -1,5 +1,6 @@
 using Microsoft.AspNetCore.HttpLogging;
 using Microsoft.AspNetCore.Identity;
+using Scalar.AspNetCore;
 
 var builder = WebApplication.CreateBuilder(args);
 
@@ -22,8 +23,7 @@
 builder.Services.AddCurrentUser();
 
 // Configure Open API
-builder.Services.AddEndpointsApiExplorer();
-builder.Services.AddSwaggerGen(o => o.AddOpenApiSecurity());
+builder.Services.AddOpenApi();
 
 // Configure rate limiting
 builder.Services.AddRateLimiting();
@@ -44,10 +44,11 @@
 
 if (app.Environment.IsDevelopment())
 {
-    app.UseSwagger();
-    app.UseSwaggerUI();
+    app.MapScalarApiReference();
 }
 
+app.MapOpenApi();
+
 app.MapDefaultEndpoints();
 
 app.Map("/", () => Results.Redirect("/swagger"));

diff --git a/TodoApi/Properties/launchSettings.json b/TodoApi/Properties/launchSettings.json
@@ -12,7 +12,7 @@
       "commandName": "Project",
       "dotnetRunMessages": true,
       "launchBrowser": true,
-      "launchUrl": "swagger",
+      "launchUrl": "scalar/v1",
       "hotReloadProfile": "aspnetcore",
       "applicationUrl": "http://localhost:5000",
       "environmentVariables": {
@@ -23,7 +23,7 @@
       "commandName": "Project",
       "dotnetRunMessages": true,
       "launchBrowser": true,
-      "launchUrl": "swagger",
+      "launchUrl": "scalar/v1",
       "hotReloadProfile": "aspnetcore",
       "applicationUrl": "https://localhost:5001;http://localhost:5000",
       "environmentVariables": {

diff --git a/TodoApi/TodoApi.csproj b/TodoApi/TodoApi.csproj
@@ -13,7 +13,7 @@
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" />
     <PackageReference Include="Microsoft.OpenApi" />
     <PackageReference Include="MiniValidation" />
-    <PackageReference Include="Swashbuckle.AspNetCore" />
+    <PackageReference Include="Scalar.AspNetCore" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/TodoApi/Todos/TodoApi.cs b/TodoApi/Todos/TodoApi.cs
@@ -13,8 +13,7 @@ public static RouteGroupBuilder MapTodos(this IEndpointRouteBuilder routes)
 
         // Add security requirements, all incoming requests to this API *must*
         // be authenticated with a valid user.
-        group.RequireAuthorization(pb => pb.RequireCurrentUser())
-             .AddOpenApiSecurity();
+        group.RequireAuthorization(pb => pb.RequireCurrentUser());
 
         // Rate limit all of the APIs
         group.RequirePerUserRateLimit();