Bump Microsoft.OpenApi from 1.6.24 to 3.3.1

QrCodeApiApp/Program.cs

@@ -7,18 +7,22 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Hosting;
 
 namespace QrCodeApiApp
 {
     public class Program
     {
         public static void Main(string[] args)
         {
-            CreateWebHostBuilder(args).Build().Run();
+            CreateHostBuilder(args).Build().Run();
         }
 
-        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
-            WebHost.CreateDefaultBuilder(args)
-                .UseStartup<Startup>();
+        public static IHostBuilder CreateHostBuilder(string[] args) =>
+            Host.CreateDefaultBuilder(args)
+                .ConfigureWebHostDefaults(webBuilder =>
+                {
+                    webBuilder.UseStartup<Startup>();
+                });
     }
 }

QrCodeApiApp/QrCodeApiApp.csproj

@@ -1,7 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>net8.0</TargetFramework>
+    <TargetFramework>net10.0</TargetFramework>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
@@ -10,8 +12,7 @@
 
   <ItemGroup>
     <PackageReference Include="joelbyford.BasicAuth" Version="1.2.0" />
-    <PackageReference Include="Microsoft.OpenApi" Version="1.6.24" />
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.3" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="10.1.1" />
     <PackageReference Include="System.Drawing.Common" Version="9.0.4" />
     <PackageReference Include="ZXing.Net" Version="0.16.10" />
   </ItemGroup>

QrCodeApiApp/Startup.cs

@@ -10,10 +10,11 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
-using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi;
 using joelbyford;
 using System.IO;
 using System.Text.Json;
+using System.Reflection;
 
 namespace QrCodeApiApp
 {
@@ -35,6 +36,11 @@ public void ConfigureServices(IServiceCollection services)
             services.AddSwaggerGen(c =>
             {
                 c.SwaggerDoc("v1", new OpenApiInfo { Title = "QrCodeApiApp", Version = "v1" });
+                // Set the comments path for the Swagger JSON and UI.
+                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
+                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
+                c.IncludeXmlComments(xmlPath);
+
             });
         }
 
@@ -44,9 +50,12 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             if (env.IsDevelopment())
             {
                 app.UseDeveloperExceptionPage();
-                app.UseSwagger();
-                app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "QrCodeApiApp v1"));
             }
+
+            // Always share the swagger info
+            app.UseSwagger();
+            app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "QrCodeApiApp v1"));
+
             //Insert the Basic Authentication Middleware handler *ONLY IF* it was enabled in appsettings.json
             bool basicAuthEnabled = this.Configuration.GetValue<bool>("AppSettings:BasicAuth:Enabled");
 

QrCodeApiApp/test/manualTesting.http

@@ -1,3 +1,14 @@
+# Provided here are several examples that can be used to test the API that it is functioning correctly when running on the localhost.
+#
+# To make use of this file, you can use the REST Client extension for Visual Studio Code:
+# https://marketplace.visualstudio.com/items?itemName=humao.rest-client
+
+###########################
+# Swagger/Swashbuckle Test
+# =========================
+GET http://localhost:5000/swagger
+
+####
 # Example GET sending the text "SomeTextToEncode" - ANONYMOUS ACCESS
 GET http://localhost:5000/api/encode?text=SomeTextToEncode&size=150