Add swagger to preservation api

digirati-co-uk · Apr 30, 2024 · c9647f3 · c9647f3
1 parent 767e401
commit c9647f3
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/LeedsExperiment/Preservation.API/Preservation.API.csproj b/LeedsExperiment/Preservation.API/Preservation.API.csproj
@@ -4,11 +4,17 @@
         <TargetFramework>net8.0</TargetFramework>
         <Nullable>enable</Nullable>
         <ImplicitUsings>enable</ImplicitUsings>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <NoWarn>$(NoWarn);1591</NoWarn>
     </PropertyGroup>
 
     <ItemGroup>
       <ProjectReference Include="..\PreservationApiClient\PreservationApiClient.csproj" />
       <ProjectReference Include="..\Preservation\Preservation.csproj" />
     </ItemGroup>
 
+    <ItemGroup>
+      <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    </ItemGroup>
+
 </Project>
diff --git a/LeedsExperiment/Preservation.API/Program.cs b/LeedsExperiment/Preservation.API/Program.cs
@@ -1,5 +1,7 @@
+using System.Reflection;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using Microsoft.OpenApi.Models;
 using Preservation;
 using PreservationApiClient;
 
@@ -21,7 +23,20 @@
     client.DefaultRequestHeaders.Add("Accept", "application/json");
 });
 
-// TODO - swagger
+builder.Services.AddEndpointsApiExplorer();
+builder.Services.AddSwaggerGen(opts =>
+{
+    opts.SwaggerDoc("v1", new OpenApiInfo
+    {
+        Title = "UoL Demo Preservation API",
+        Version = "v0.1",
+        Description =
+            "Preservation API is consumed by the applications we are going to build. For demo/test purposes only, focussed on 'happy path' (minimal error handling etc)."
+    });
+
+    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
+    opts.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename));
+});
 
 var app = builder.Build();
 
@@ -40,6 +55,8 @@
 app.MapGet("/deposits/{id}/importJobs/diff", (string id) => $"Get importJob JSON for files in Deposit {id}");
 app.MapPost("/deposits/{id}/importJobs", (string id) => "Import data into Fedora");
 
+app.UseSwagger();
+app.UseSwaggerUI();
 app.UseHttpsRedirection();
 app.MapControllers();
 app.UseHttpLogging();

diff --git a/LeedsExperiment/Preservation.API/Properties/launchSettings.json b/LeedsExperiment/Preservation.API/Properties/launchSettings.json
@@ -5,6 +5,7 @@
       "commandName": "Project",
       "dotnetRunMessages": true,
       "launchBrowser": false,
+      "launchUrl": "swagger",
       "applicationUrl": "http://localhost:5074",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
@@ -14,6 +15,7 @@
       "commandName": "Project",
       "dotnetRunMessages": true,
       "launchBrowser": false,
+      "launchUrl": "swagger",
       "applicationUrl": "https://localhost:7169;http://localhost:5074",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"