Add WithVariable server extension method

Author: waxtell

SampleApp9000/Controllers/WeatherForecastController.cs

@@ -2,37 +2,34 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.AspNetCore.Mvc;
-using Microsoft.Extensions.Logging;
 
-namespace SampleApp9000.Controllers
+namespace SampleApp9000.Controllers;
+
+[ApiController]
+[Route("[controller]")]
+public class WeatherForecastController : ControllerBase
 {
-    [ApiController]
-    [Route("[controller]")]
-    public class WeatherForecastController : ControllerBase
+    private static readonly string[] Summaries = 
     {
-        private static readonly string[] Summaries = new[]
-        {
-            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
-        };
-
-        private readonly ILogger<WeatherForecastController> _logger;
+        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
+    };
 
-        public WeatherForecastController(ILogger<WeatherForecastController> logger)
-        {
-            _logger = logger;
-        }
-
-        [HttpGet]
-        public IEnumerable<WeatherForecast> Get()
-        {
-            var rng = new Random();
-            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
-            {
-                Date = DateTime.Now.AddDays(index),
-                TemperatureC = rng.Next(-20, 55),
-                Summary = Summaries[rng.Next(Summaries.Length)]
-            })
-            .ToArray();
-        }
+    [HttpGet]
+    public IEnumerable<WeatherForecast> Get()
+    {
+        var rng = new Random();
+        return 
+            Enumerable
+                .Range(1, 5)
+                .Select
+                (
+                    index => new WeatherForecast
+                    {
+                        Date = DateTime.Now.AddDays(index),
+                        TemperatureC = rng.Next(-20, 55),
+                        Summary = Summaries[rng.Next(Summaries.Length)]
+                    }
+                )
+                .ToArray();
     }
-}
+}

SampleApp9000/Program.cs

@@ -1,20 +1,19 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Hosting;
 
-namespace SampleApp9000
+namespace SampleApp9000;
+
+public class Program
 {
-    public class Program
+    public static void Main(string[] args)
     {
-        public static void Main(string[] args)
-        {
-            CreateHostBuilder(args).Build().Run();
-        }
-
-        public static IHostBuilder CreateHostBuilder(string[] args) =>
-            Host.CreateDefaultBuilder(args)
-                .ConfigureWebHostDefaults(webBuilder =>
-                {
-                    webBuilder.UseStartup<Startup>();
-                });
+        CreateHostBuilder(args).Build().Run();
     }
-}
+
+    public static IHostBuilder CreateHostBuilder(string[] args) =>
+        Host.CreateDefaultBuilder(args)
+            .ConfigureWebHostDefaults(webBuilder =>
+            {
+                webBuilder.UseStartup<Startup>();
+            });
+}

SampleApp9000/SampleApp9000.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>

SampleApp9000/Startup.cs

@@ -1,4 +1,3 @@
-using System.Collections.Generic;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.OpenApi.Models;
@@ -7,75 +6,72 @@
 using Microsoft.Extensions.Hosting;
 using Swashbuckle.Servers.Extension;
 
-namespace SampleApp9000
+namespace SampleApp9000;
+
+public class Startup
 {
-    public class Startup
+    public Startup(IConfiguration configuration)
     {
-        public Startup(IConfiguration configuration)
-        {
-            Configuration = configuration;
-        }
+        Configuration = configuration;
+    }
 
-        public IConfiguration Configuration { get; }
+    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)
-        {
-            services.AddControllers();
+    // This method gets called by the runtime. Use this method to add services to the container.
+    public void ConfigureServices(IServiceCollection services)
+    {
+        services.AddControllers();
 
-            services.AddSwaggerGen(c =>
-            {
-                c.SwaggerDoc
-                (
-                    "sampleapp",
-                    new OpenApiInfo
-                    {
-                        Title = "Sample App 9000",
-                        Version = "1.0.0",
-                        Description = "Provides a simple example of the tool"
-                    }
-                );
+        services.AddSwaggerGen(c =>
+        {
+            c.SwaggerDoc
+            (
+                "sampleapp",
+                new OpenApiInfo
+                {
+                    Title = "Sample App 9000",
+                    Version = "1.0.0",
+                    Description = "Provides a simple example of the tool"
+                }
+            );
 
-                c.WithServers
-                (
-                    new List<OpenApiServer>
-                    {
-                        new OpenApiServer { Url = "http://localhost:5000" },
-                        new OpenApiServer { Url = "https://www.yourcustomdomain.com" }
-                    }
-                );
-            });
-        }
+            c.WithServers
+            (
+                new[]
+                {
+                    new OpenApiServer { Url = "http://localhost:5000" },
+                    new OpenApiServer { Url = "https://www.yourcustomdomain.com" }
+                }
+            );
+        });
+    }
 
-        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
-        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+    {
+        if (env.IsDevelopment())
         {
-            if (env.IsDevelopment())
-            {
-                app.UseDeveloperExceptionPage();
-            }
+            app.UseDeveloperExceptionPage();
+        }
 
-            app.UseHttpsRedirection();
+        app.UseHttpsRedirection();
 
-            app.UseRouting();
+        app.UseRouting();
 
-            app.UseAuthorization();
+        app.UseAuthorization();
 
-            app.UseSwagger();
+        app.UseSwagger();
 
-            // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), 
-            // specifying the Swagger JSON endpoint.
-            app.UseSwaggerUI(x =>
-            {
-                x.DocumentTitle = "SampleApp9000";
-                x.SwaggerEndpoint("/swagger/sampleapp/swagger.json", "Sample App 9000");
-                x.RoutePrefix = string.Empty;
-            });
+        app.UseSwaggerUI(x =>
+        {
+            x.DocumentTitle = "SampleApp9000";
+            x.SwaggerEndpoint("/swagger/sampleapp/swagger.json", "Sample App 9000");
+            x.RoutePrefix = string.Empty;
+        });
 
-            app.UseEndpoints(endpoints =>
-            {
-                endpoints.MapControllers();
-            });
-        }
+        app.UseEndpoints(endpoints =>
+        {
+            endpoints.MapControllers();
+        });
     }
-}
+}

SampleApp9000/WeatherForecast.cs

@@ -1,15 +1,14 @@
 using System;
 
-namespace SampleApp9000
+namespace SampleApp9000;
+
+public class WeatherForecast
 {
-    public class WeatherForecast
-    {
-        public DateTime Date { get; set; }
+    public DateTime Date { get; set; }
 
-        public int TemperatureC { get; set; }
+    public int TemperatureC { get; set; }
 
-        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
+    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
 
-        public string Summary { get; set; }
-    }
-}
+    public string Summary { get; set; }
+}

Swashbuckle.Servers.Extension/Extensions/OpenApiServerExtensions.cs

@@ -0,0 +1,14 @@
+using Microsoft.OpenApi.Models;
+
+namespace Swashbuckle.Servers.Extension.Extensions
+{
+    public static class OpenApiServerExtensions
+    {
+        public static OpenApiServer WithVariable(this OpenApiServer server, string key, OpenApiServerVariable value)
+        {
+            server.Variables.Add(key, value);
+
+            return server;
+        }
+    }
+}

Swashbuckle.Servers.Extension/Swashbuckle.Servers.Extension.csproj

@@ -8,9 +8,12 @@
     <RepositoryUrl>https://github.com/waxtell/Swashbuckle.Servers.Extension.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageTags>OAS Swashbuckle Servers</PackageTags>
-    <PackageReleaseNotes>1.0.2- Now supports multiple, concatenating invocations
-1.0.1- Initial release</PackageReleaseNotes>
-    <Version>1.0.2</Version>
+    <PackageReleaseNotes>
+        1.0.3 - Add WithVariable extension
+	    1.0.2 - Now supports multiple, concatenating invocations
+		1.0.1 - Initial release
+    </PackageReleaseNotes>
+    <Version>1.0.3</Version>
   </PropertyGroup>
 
   <ItemGroup>