feat: register swagger endpoints for data and run services

Author: NinjaRocks

src/Abacus.Data.Service/Abacus.Data.Service.csproj

@@ -14,5 +14,6 @@
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="$(MicrosoftExtensionsVersion)" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="$(MicrosoftExtensionsVersion)" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="$(MicrosoftExtensionsVersion)" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="10.2.3" />
   </ItemGroup>
 </Project>

src/Abacus.Data.Service/Program.cs

@@ -42,11 +42,28 @@ public static void Main(string[] args)
         builder.Services.AddSingleton<IAssessmentReportRenderer, AssessmentReportRenderer>();
         builder.Services.AddHostedService<QaDataDatabaseInitializer>();
 
+        builder.Services.AddEndpointsApiExplorer();
+        builder.Services.AddSwaggerGen(c =>
+        {
+            c.SwaggerDoc("v1", new Microsoft.OpenApi.OpenApiInfo
+            {
+                Title = "Abacus Data Service API",
+                Version = "v1"
+            });
+        });
+
         WebApplication app = builder.Build();
 
         app.UseExceptionHandler();
         app.UseStatusCodePages();
 
+        app.UseSwagger();
+        app.UseSwaggerUI(c =>
+        {
+            c.SwaggerEndpoint("/swagger/v1/swagger.json", "Abacus Data Service API v1");
+            c.RoutePrefix = "swagger";
+        });
+
         app.MapCatalogEndpoints();
         app.MapAssessmentEndpoints();
         app.MapGet("/health/live", () => Results.Ok(new { status = "live" }));

src/Abacus.Run.Service/Abacus.Run.Service.csproj

@@ -6,6 +6,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.AI.OpenAI" Version="10.8.3" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="10.2.3" />
     <ProjectReference Include="../Abacus.Run/Abacus.Run.csproj" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="9.0.9" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="9.0.9" />

src/Abacus.Run.Service/Program.cs

@@ -71,11 +71,28 @@
         ChatClientEmbeddingGenerator>();
 }
 
+builder.Services.AddEndpointsApiExplorer();
+builder.Services.AddSwaggerGen(c =>
+{
+    c.SwaggerDoc("v1", new Microsoft.OpenApi.OpenApiInfo
+    {
+        Title = "Abacus Run Service API",
+        Version = "v1"
+    });
+});
+
 WebApplication app = builder.Build();
 
 app.UseExceptionHandler();
 app.UseStatusCodePages();
 
+app.UseSwagger();
+app.UseSwaggerUI(c =>
+{
+    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Abacus Run Service API v1");
+    c.RoutePrefix = "swagger";
+});
+
 app.UseStaticFiles();
 app.UseRouting();
 

tests/Abacus.Run.IntegrationTests/Abacus.Run.IntegrationTests.csproj

@@ -4,6 +4,7 @@
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="../../src/Abacus.Run.Service/Abacus.Run.Service.csproj" />
+    <ProjectReference Include="../../src/Abacus.Data.Service/Abacus.Data.Service.csproj" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
     <PackageReference Include="xunit" Version="2.9.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />

tests/Abacus.Run.IntegrationTests/ControlPlaneIntegrationTests.cs

@@ -123,4 +123,16 @@ public async Task Layout_asset_links_resolve()
             asset.StatusCode.Should().Be(HttpStatusCode.OK, $"{match.Groups[1].Value} is referenced by the layout");
         }
     }
+
+    [Fact]
+    public async Task Swagger_Endpoints_Return_200_OK()
+    {
+        HttpResponseMessage swaggerJson = await _client.GetAsync("/swagger/v1/swagger.json");
+        swaggerJson.StatusCode.Should().Be(HttpStatusCode.OK);
+        string json = await swaggerJson.Content.ReadAsStringAsync();
+        json.Should().Contain("Abacus Run Service API");
+
+        HttpResponseMessage swaggerUi = await _client.GetAsync("/swagger/");
+        swaggerUi.StatusCode.Should().Be(HttpStatusCode.OK);
+    }
 }

tests/Abacus.Run.IntegrationTests/Workflows/SuitabilityQa/QaDataServiceApiTests.cs

@@ -180,4 +180,18 @@ public async Task Report_is_unavailable_until_the_assessment_completes()
         report.StatusCode.Should().Be(HttpStatusCode.Conflict,
             "an unfinished assessment has no report to serve, and an empty body would read as 'no findings'");
     }
+
+    [Fact]
+    public async Task Swagger_Endpoints_Return_200_OK()
+    {
+        using HttpClient client = _service.CreateClient();
+
+        HttpResponseMessage swaggerJson = await client.GetAsync("/swagger/v1/swagger.json");
+        swaggerJson.StatusCode.Should().Be(HttpStatusCode.OK);
+        string json = await swaggerJson.Content.ReadAsStringAsync();
+        json.Should().Contain("Abacus Data Service API");
+
+        HttpResponseMessage swaggerUi = await client.GetAsync("/swagger/");
+        swaggerUi.StatusCode.Should().Be(HttpStatusCode.OK);
+    }
 }