Support multiple instances of Swagger middleware with scoped options

domaindrivendev · Feb 16, 2021 · 89d75c1 · 89d75c1
1 parent 392de3e
commit 89d75c1
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 17 deletions.
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -6,7 +6,7 @@
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <LicenseUrl>https://licenses.nuget.org/MIT</LicenseUrl>
-    <VersionPrefix>6.0.6</VersionPrefix>
+    <VersionPrefix>6.0.7</VersionPrefix>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/Swashbuckle.AspNetCore.Swagger/DependencyInjection/SwaggerBuilderExtensions.cs b/src/Swashbuckle.AspNetCore.Swagger/DependencyInjection/SwaggerBuilderExtensions.cs
@@ -29,8 +29,12 @@ public static IApplicationBuilder UseSwagger(
             this IApplicationBuilder app,
             Action<SwaggerOptions> setupAction = null)
         {
-            SwaggerOptions options = app.ApplicationServices.GetRequiredService<IOptions<SwaggerOptions>>().Value;
-            setupAction?.Invoke(options);
+            SwaggerOptions options;
+            using (var scope = app.ApplicationServices.CreateScope())
+            {
+                options = scope.ServiceProvider.GetRequiredService<IOptionsSnapshot<SwaggerOptions>>().Value;
+                setupAction?.Invoke(options);
+            }
 
             return app.UseSwagger(options);
         }

diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/ReDocIntegrationTests.cs b/test/Swashbuckle.AspNetCore.IntegrationTests/ReDocIntegrationTests.cs
@@ -47,7 +47,7 @@ public async Task IndexUrl_IgnoresUrlCase()
         [Theory]
         [InlineData("/redoc/1.0/index.html", "/swagger/1.0/swagger.json")]
         [InlineData("/redoc/2.0/index.html", "/swagger/2.0/swagger.json")]
-        public async Task VersionUrls_ProperlyHandlesDifferentVersions(string redocUrl, string swaggerPath)
+        public async Task ReDocMiddleware_CanBeConfiguredMultipleTimes(string redocUrl, string swaggerPath)
         {
             var client = new TestSite(typeof(MultipleVersions.Startup)).BuildClient();
 

diff --git a/...rationTests/SwaggerGenIntegrationTests.cs → ...tegrationTests/SwaggerIntegrationTests.cs b/...rationTests/SwaggerGenIntegrationTests.cs → ...tegrationTests/SwaggerIntegrationTests.cs
@@ -2,6 +2,7 @@
 using System.Globalization;
 using System.Linq;
 using System.Text;
+using System.Text.Json;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Readers;
@@ -10,7 +11,7 @@
 
 namespace Swashbuckle.AspNetCore.IntegrationTests
 {
-    public class SwaggerGenIntegrationTests
+    public class SwaggerIntegrationTests
     {
         [Theory]
         [InlineData(typeof(Basic.Startup), "/swagger/v1/swagger.json")]
@@ -113,5 +114,24 @@ public async Task SwaggerEndpoint_InfersServerMetadata_FromRequestHeaders(
             Assert.Equal(1, openApiDoc.Servers.Count);
             Assert.Equal(expectedServerUrl, openApiDoc.Servers[0].Url);
         }
+
+        [Theory]
+        [InlineData("/swagger/v1/swagger.json", "openapi", "3.0.1")]
+        [InlineData("/swagger/v1/swaggerv2.json", "swagger", "2.0")]
+        public async Task SwaggerMiddleware_CanBeConfiguredMultipleTimes(
+            string swaggerUrl,
+            string expectedVersionProperty,
+            string expectedVersionValue)
+        {
+            var client = new TestSite(typeof(Basic.Startup)).BuildClient();
+
+            var response = await client.GetAsync(swaggerUrl);
+
+            response.EnsureSuccessStatusCode();
+            var contentStream = await response.Content.ReadAsStreamAsync();
+
+            var json = await JsonSerializer.DeserializeAsync<JsonElement>(contentStream);
+            Assert.Equal(expectedVersionValue, json.GetProperty(expectedVersionProperty).GetString());
+        }
     }
 }
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/SwaggerUIIntegrationTests.cs b/test/Swashbuckle.AspNetCore.IntegrationTests/SwaggerUIIntegrationTests.cs
@@ -59,7 +59,7 @@ public async Task IndexUrl_ReturnsCustomIndexHtml_IfConfigured()
         [InlineData("/swagger/index.html", new [] { "Version 1.0", "Version 2.0" })]
         [InlineData("/swagger/1.0/index.html", new [] { "Version 1.0" })]
         [InlineData("/swagger/2.0/index.html", new [] { "Version 2.0" })]
-        public async Task VersionUrls_ProperlyHandlesDifferentVersions(string swaggerUiUrl, string[] versions)
+        public async Task SwaggerUIMiddleware_CanBeConfiguredMultipleTimes(string swaggerUiUrl, string[] versions)
         {
             var client = new TestSite(typeof(MultipleVersions.Startup)).BuildClient();
 

diff --git a/test/WebSites/Basic/Startup.cs b/test/WebSites/Basic/Startup.cs
@@ -71,7 +71,13 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             app.UseEndpoints(endpoints =>
             {
                 endpoints.MapControllers();
+
+                // Expose Swagger/OpenAPI JSON in new (v3) and old (v2) formats
                 endpoints.MapSwagger("swagger/{documentName}/swagger.json");
+                endpoints.MapSwagger("swagger/{documentName}/swaggerv2.json", c =>
+                {
+                    c.SerializeAsV2 = true;
+                });
             });
 
             var supportedCultures = new[]

diff --git a/test/WebSites/NetCore21/Startup.cs b/test/WebSites/NetCore21/Startup.cs
@@ -6,7 +6,6 @@
 using Microsoft.OpenApi.Models;
 using Newtonsoft.Json.Converters;
 using Newtonsoft.Json.Serialization;
-using Swashbuckle.AspNetCore.Swagger;
 
 namespace NetCore21
 {
@@ -49,16 +48,7 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env)
 
             app.UseMvc();
 
-            // Expose v2 and v3 Swagger/OpenAPI formats
-            app.UseSwagger(new SwaggerOptions
-            {
-                RouteTemplate = "/swagger/{documentName}/swagger.json",
-                SerializeAsV2 = true
-            });
-            app.UseSwagger(new SwaggerOptions
-            {
-                RouteTemplate = "/swagger/{documentName}/openapi.json",
-            });
+            app.UseSwagger();
 
             app.UseSwaggerUI();
         }