Merge pull request #5 from Scott-transtar/develop

Upgrade to .NET 8.0 and Swashbuckle.AspNetCore v10.1.0; update workfl…

Author: waxtell

.github/workflows/build.yml

@@ -8,10 +8,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - name: Setup .NET Core
-      uses: actions/setup-dotnet@v1
+      uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 7.0.x
+        dotnet-version: 9.0.x
     - name: Build with dotnet
       run: dotnet build --configuration Release

.github/workflows/publishtonuget.yml

@@ -8,7 +8,7 @@ jobs:
     name: publish to nuget
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
 
       # Publish
       - name: Publish NuGet

SampleApp9000/Controllers/WeatherForecastController.cs

@@ -9,15 +9,16 @@ namespace SampleApp9000.Controllers;
 [Route("[controller]")]
 public class WeatherForecastController : ControllerBase
 {
-    private static readonly string[] Summaries = 
-    {
+    private static readonly string[] Summaries =
+    [
         "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
-    };
+    ];
 
     [HttpGet]
     public IEnumerable<WeatherForecast> Get()
     {
         var rng = new Random();
+
         return 
             Enumerable
                 .Range(1, 5)

SampleApp9000/SampleApp9000.csproj

@@ -1,7 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <NoWarn>NU1900</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

SampleApp9000/Startup.cs

@@ -1,7 +1,6 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
-using Microsoft.OpenApi.Models;
-using Microsoft.Extensions.Configuration;
+using Microsoft.OpenApi;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Swashbuckle.Servers.Extension;
@@ -10,13 +9,6 @@ namespace SampleApp9000;
 
 public class Startup
 {
-    public Startup(IConfiguration configuration)
-    {
-        Configuration = configuration;
-    }
-
-    public IConfiguration Configuration { get; }
-
     // This method gets called by the runtime. Use this method to add services to the container.
     public void ConfigureServices(IServiceCollection services)
     {
@@ -37,11 +29,10 @@ public void ConfigureServices(IServiceCollection services)
 
             c.WithServers
             (
-                new[]
-                {
+                [
                     new OpenApiServer { Url = "http://localhost:5000" },
                     new OpenApiServer { Url = "https://www.yourcustomdomain.com" }
-                }
+                ]
             );
         });
     }

Swashbuckle.Servers.Extension.sln.DotSettings

@@ -0,0 +1,2 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+<s:Boolean x:Key="/Default/UserDictionary/Words/=sampleapp/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

Swashbuckle.Servers.Extension/Extensions/OpenApiServerExtensions.cs

@@ -1,14 +1,18 @@
-using Microsoft.OpenApi.Models;
+using System;
+using System.Collections.Generic;
+using Microsoft.OpenApi;
 
-namespace Swashbuckle.Servers.Extension.Extensions
+namespace Swashbuckle.Servers.Extension.Extensions;
+
+public static class OpenApiServerExtensions
 {
-    public static class OpenApiServerExtensions
+    public static OpenApiServer WithVariable(this OpenApiServer server, string key, OpenApiServerVariable value)
     {
-        public static OpenApiServer WithVariable(this OpenApiServer server, string key, OpenApiServerVariable value)
-        {
-            server.Variables.Add(key, value);
+        ArgumentNullException.ThrowIfNull(server);
+
+        server.Variables ??= new Dictionary<string, OpenApiServerVariable>();
+        server.Variables.Add(key, value);
 
-            return server;
-        }
+        return server;
     }
 }

Swashbuckle.Servers.Extension/Extensions/SwaggerGenOptionsExtensions.cs

@@ -2,50 +2,51 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
 // ReSharper disable once CheckNamespace
-namespace Swashbuckle.Servers.Extension
+#pragma warning disable IDE0130 // Namespace does not match folder structure
+namespace Swashbuckle.Servers.Extension;
+#pragma warning restore IDE0130 // Namespace does not match folder structure
+
+public static class SwaggerGenOptionsExtensions
 {
-    public static class SwaggerGenOptionsExtensions
+    public static SwaggerGenOptions WithServers(this SwaggerGenOptions swaggerGenOptions, Action<ServersOptions> setupAction)
     {
-        public static SwaggerGenOptions WithServers(this SwaggerGenOptions swaggerGenOptions, Action<ServersOptions> setupAction)
-        {
-            var options = new ServersOptions();
+        var options = new ServersOptions();
 
-            setupAction.Invoke(options);
+        setupAction.Invoke(options);
 
-            swaggerGenOptions.AddOrUpdate(options);
+        swaggerGenOptions.AddOrUpdate(options);
 
-            return swaggerGenOptions;
-        }
+        return swaggerGenOptions;
+    }
 
-        public static SwaggerGenOptions WithServers(this SwaggerGenOptions swaggerGenOptions, IEnumerable<OpenApiServer> servers)
-        {
-            var options = new ServersOptions { Servers = servers };
+    public static SwaggerGenOptions WithServers(this SwaggerGenOptions swaggerGenOptions, IEnumerable<OpenApiServer> servers)
+    {
+        var options = new ServersOptions { Servers = servers };
 
-            swaggerGenOptions.AddOrUpdate(options);
+        swaggerGenOptions.AddOrUpdate(options);
 
-            return swaggerGenOptions;
-        }
+        return swaggerGenOptions;
+    }
+
+    private static void AddOrUpdate(this SwaggerGenOptions swaggerGenOptions, ServersOptions options)
+    {
+        var filter = swaggerGenOptions
+                        .DocumentFilterDescriptors
+                        .Find(x => x.Type == typeof(ServersDocumentFilter));
 
-        private static void AddOrUpdate(this SwaggerGenOptions swaggerGenOptions, ServersOptions options)
+        if (filter != null)
+        {
+            var existingOptions = (ServersOptions) filter.Arguments[0];
+
+            existingOptions.Servers = existingOptions.Servers.Concat(options.Servers);
+        }
+        else
         {
-            var filter = swaggerGenOptions
-                            .DocumentFilterDescriptors
-                            .Find(x => x.Type == typeof(ServersDocumentFilter));
-
-            if (filter != null)
-            {
-                var existingOptions = (ServersOptions) filter.Arguments[0];
-
-                existingOptions.Servers = existingOptions.Servers.Concat(options.Servers);
-            }
-            else
-            {
-                swaggerGenOptions.DocumentFilter<ServersDocumentFilter>(options);
-            }
+            swaggerGenOptions.DocumentFilter<ServersDocumentFilter>(options);
         }
     }
 }

Swashbuckle.Servers.Extension/Options/ServersOptions.cs

@@ -1,11 +1,10 @@
 using System.Collections.Generic;
-using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi;
 
 // ReSharper disable once CheckNamespace
-namespace Swashbuckle.Servers.Extension
+namespace Swashbuckle.Servers.Extension;
+
+public class ServersOptions
 {
-    public class ServersOptions
-    {
-        public IEnumerable<OpenApiServer> Servers { get; set; }
-    }
+    public IEnumerable<OpenApiServer> Servers { get; set; }
 }

Swashbuckle.Servers.Extension/ServersDocumentFilter.cs

@@ -1,21 +1,13 @@
 using System.Linq;
-using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
-namespace Swashbuckle.Servers.Extension
+namespace Swashbuckle.Servers.Extension;
+
+internal class ServersDocumentFilter(ServersOptions options) : IDocumentFilter
 {
-    internal class ServersDocumentFilter : IDocumentFilter
+    public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
     {
-        private readonly ServersOptions _options;
-
-        public ServersDocumentFilter(ServersOptions options)
-        {
-            _options = options;
-        }
-
-        public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
-        {
-            swaggerDoc.Servers = _options?.Servers?.ToList();
-        }
+        swaggerDoc.Servers = options?.Servers?.ToList();
     }
 }