feat: scalar integration (#13)

nventive · Dec 2, 2024 · 8bcd90a · 8bcd90a
1 parent c101d8c
commit 8bcd90a
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/template/src/Placeholder.ApiService/Program.cs b/template/src/Placeholder.ApiService/Program.cs
@@ -14,6 +14,7 @@
 // Configure the HTTP request pipeline.
 app.UseExceptionHandler();
 
+app.ConfigureOpenApi();
 app.MapWeatherEndpoints();
 app.MapDefaultEndpoints();
 

diff --git a/template/src/Placeholder.ApiService/Properties/launchSettings.json b/template/src/Placeholder.ApiService/Properties/launchSettings.json
@@ -5,6 +5,7 @@
       "commandName": "Project",
       "launchBrowser": true,
       "applicationUrl": "http://localhost:7587",
+      "launchUrl": "http://localhost:7587/scalar/v1",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development",
         "ASPIRE_ALLOW_UNSECURED_TRANSPORT": "true",

diff --git a/template/src/Placeholder.ServiceDefaults/Extensions.cs b/template/src/Placeholder.ServiceDefaults/Extensions.cs
@@ -6,6 +6,7 @@
 using OpenTelemetry;
 using OpenTelemetry.Metrics;
 using OpenTelemetry.Trace;
+using Scalar.AspNetCore;
 
 namespace Microsoft.Extensions.Hosting;
 
@@ -31,6 +32,8 @@ public static IHostApplicationBuilder AddServiceDefaults(this IHostApplicationBu
             http.AddServiceDiscovery();
         });
 
+        builder.Services.AddOpenApi();
+
         return builder;
     }
 
@@ -108,4 +111,20 @@ public static WebApplication MapDefaultEndpoints(this WebApplication app)
 
         return app;
     }
+
+    public static WebApplication ConfigureOpenApi(this WebApplication app)
+    {
+        if (!app.Environment.IsProduction())
+        {
+            app.MapOpenApi();
+            app.MapScalarApiReference(options =>
+            {
+                // This is necessary to ensure consistent API url mapping between the Scalar UI and the browser
+                // See comments in https://dev.azure.com/nventive/Practice%20committees/_workitems/edit/305140 for more information
+                options.Servers = Array.Empty<ScalarServer>();
+            });
+        }
+
+        return app;
+    }
 }
diff --git a/template/src/Placeholder.ServiceDefaults/Placeholder.ServiceDefaults.csproj b/template/src/Placeholder.ServiceDefaults/Placeholder.ServiceDefaults.csproj
@@ -9,6 +9,7 @@
 
   <ItemGroup>
     <FrameworkReference Include="Microsoft.AspNetCore.App" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
 
     <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.10.0" />
     <PackageReference Include="Microsoft.Extensions.ServiceDiscovery" Version="9.0.0-rc.1.24511.1" />
@@ -17,6 +18,7 @@
     <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />
     <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.9.0" />
     <PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.9.0" />
+    <PackageReference Include="Scalar.AspNetCore" Version="1.2.42" />
   </ItemGroup>
 
 </Project>