From 98a02fc33854fa84e2a2923e939ff1ebc6208366 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 4 Feb 2026 16:56:44 +0000 Subject: [PATCH 1/2] Bump Microsoft.OpenApi from 1.6.24 to 3.3.1 --- updated-dependencies: - dependency-name: Microsoft.OpenApi dependency-version: 3.3.1 dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- QrCodeApiApp/QrCodeApiApp.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/QrCodeApiApp/QrCodeApiApp.csproj b/QrCodeApiApp/QrCodeApiApp.csproj index b24388d..fb1c7d5 100644 --- a/QrCodeApiApp/QrCodeApiApp.csproj +++ b/QrCodeApiApp/QrCodeApiApp.csproj @@ -10,7 +10,7 @@ - + From 391a403ba2710f23d36de7aa23ba232c81fa4d15 Mon Sep 17 00:00:00 2001 From: Joel Byford Date: Wed, 4 Feb 2026 09:43:59 -0800 Subject: [PATCH 2/2] Fixes required for Swagger to function and bump to dotnet 10 --- QrCodeApiApp/Program.cs | 12 ++++++++---- QrCodeApiApp/QrCodeApiApp.csproj | 7 ++++--- QrCodeApiApp/Startup.cs | 15 ++++++++++++--- QrCodeApiApp/test/manualTesting.http | 11 +++++++++++ 4 files changed, 35 insertions(+), 10 deletions(-) diff --git a/QrCodeApiApp/Program.cs b/QrCodeApiApp/Program.cs index 084dfa3..64d2231 100644 --- a/QrCodeApiApp/Program.cs +++ b/QrCodeApiApp/Program.cs @@ -7,6 +7,7 @@ using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Hosting; namespace QrCodeApiApp { @@ -14,11 +15,14 @@ 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(); + public static IHostBuilder CreateHostBuilder(string[] args) => + Host.CreateDefaultBuilder(args) + .ConfigureWebHostDefaults(webBuilder => + { + webBuilder.UseStartup(); + }); } } diff --git a/QrCodeApiApp/QrCodeApiApp.csproj b/QrCodeApiApp/QrCodeApiApp.csproj index fb1c7d5..8a2a948 100644 --- a/QrCodeApiApp/QrCodeApiApp.csproj +++ b/QrCodeApiApp/QrCodeApiApp.csproj @@ -1,7 +1,9 @@ - net8.0 + net10.0 + true + $(NoWarn);1591 @@ -10,8 +12,7 @@ - - + diff --git a/QrCodeApiApp/Startup.cs b/QrCodeApiApp/Startup.cs index df758f0..51a5030 100644 --- a/QrCodeApiApp/Startup.cs +++ b/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("AppSettings:BasicAuth:Enabled"); diff --git a/QrCodeApiApp/test/manualTesting.http b/QrCodeApiApp/test/manualTesting.http index 4beb70d..d2af2bc 100644 --- a/QrCodeApiApp/test/manualTesting.http +++ b/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