Merge pull request #2016 from SukharevAndrey/multiple-version-urls

Handle multiple document versions in SwaggerUI and Redoc
domaindrivendev · Feb 15, 2021 · 9e99141 · 9e99141
2 parents 2e80937 + 46d829d
commit 9e99141
Show file tree

Hide file tree

Showing 6 changed files with 66 additions and 7 deletions.
diff --git a/src/Swashbuckle.AspNetCore.ReDoc/ReDocBuilderExtensions.cs b/src/Swashbuckle.AspNetCore.ReDoc/ReDocBuilderExtensions.cs
@@ -22,9 +22,12 @@ public static IApplicationBuilder UseReDoc(
             this IApplicationBuilder app,
             Action<ReDocOptions> setupAction = null)
         {
-            var options = app.ApplicationServices.GetRequiredService<IOptions<ReDocOptions>>().Value;
-
-            setupAction?.Invoke(options);
+            ReDocOptions options;
+            using (var scope = app.ApplicationServices.CreateScope())
+            {
+                options = scope.ServiceProvider.GetRequiredService<IOptionsSnapshot<ReDocOptions>>().Value;
+                setupAction?.Invoke(options);
+            }
 
             // To simplify the common case, use a default that will work with the SwaggerMiddleware defaults
             if (options.SpecUrl == null)

diff --git a/src/Swashbuckle.AspNetCore.SwaggerUI/SwaggerUIBuilderExtensions.cs b/src/Swashbuckle.AspNetCore.SwaggerUI/SwaggerUIBuilderExtensions.cs
@@ -22,9 +22,12 @@ public static IApplicationBuilder UseSwaggerUI(
             this IApplicationBuilder app,
             Action<SwaggerUIOptions> setupAction = null)
         {
-            var options = app.ApplicationServices.GetRequiredService<IOptions<SwaggerUIOptions>>().Value;
-
-            setupAction?.Invoke(options);
+            SwaggerUIOptions options;
+            using (var scope = app.ApplicationServices.CreateScope())
+            {
+                options = scope.ServiceProvider.GetRequiredService<IOptionsSnapshot<SwaggerUIOptions>>().Value;
+                setupAction?.Invoke(options);
+            }
 
             // To simplify the common case, use a default that will work with the SwaggerMiddleware defaults
             if (options.ConfigObject.Urls == null)

diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/ReDocIntegrationTests.cs b/test/Swashbuckle.AspNetCore.IntegrationTests/ReDocIntegrationTests.cs
@@ -43,5 +43,19 @@ public async Task IndexUrl_IgnoresUrlCase()
             Assert.Contains("Redoc.init", indexContent);
             Assert.Equal(HttpStatusCode.OK, jsResponse.StatusCode);
         }
+
+        [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)
+        {
+            var client = new TestSite(typeof(MultipleVersions.Startup)).BuildClient();
+
+            var response = await client.GetAsync(redocUrl);
+            var content = await response.Content.ReadAsStringAsync();
+
+            Assert.Equal(HttpStatusCode.OK, response.StatusCode);
+            Assert.Contains(swaggerPath, content);
+        }
     }
 }
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/SwaggerUIIntegrationTests.cs b/test/Swashbuckle.AspNetCore.IntegrationTests/SwaggerUIIntegrationTests.cs
@@ -54,5 +54,23 @@ public async Task IndexUrl_ReturnsCustomIndexHtml_IfConfigured()
 
             Assert.Contains("Example.com", content);
         }
+
+        [Theory]
+        [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)
+        {
+            var client = new TestSite(typeof(MultipleVersions.Startup)).BuildClient();
+
+            var response = await client.GetAsync(swaggerUiUrl);
+            var content = await response.Content.ReadAsStringAsync();
+
+            Assert.Equal(HttpStatusCode.OK, response.StatusCode);
+            foreach (var version in versions)
+            {
+                Assert.Contains(version, content);
+            }
+        }
     }
 }
diff --git a/test/WebSites/MultipleVersions/MultipleVersions.csproj b/test/WebSites/MultipleVersions/MultipleVersions.csproj
@@ -10,6 +10,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\..\src\Swashbuckle.AspNetCore.ReDoc\Swashbuckle.AspNetCore.ReDoc.csproj" />
     <ProjectReference Include="..\..\..\src\Swashbuckle.AspNetCore.Swagger\Swashbuckle.AspNetCore.Swagger.csproj" />
     <ProjectReference Include="..\..\..\src\Swashbuckle.AspNetCore.SwaggerGen\Swashbuckle.AspNetCore.SwaggerGen.csproj" />
     <ProjectReference Include="..\..\..\src\Swashbuckle.AspNetCore.SwaggerUI\Swashbuckle.AspNetCore.SwaggerUI.csproj" />

diff --git a/test/WebSites/MultipleVersions/Startup.cs b/test/WebSites/MultipleVersions/Startup.cs
@@ -38,6 +38,8 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IApiVers
                 app.UseDeveloperExceptionPage();
             }
 
+            app.UseStaticFiles();
+
             app.UseRouting();
 
             app.UseAuthorization();
@@ -48,13 +50,31 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IApiVers
             });
 
             app.UseSwagger();
+
+            // A common endpoint that contains both versions
             app.UseSwaggerUI(c =>
             {
+                c.RoutePrefix = "swagger";
                 foreach (var description in provider.ApiVersionDescriptions)
                 {
-                    c.SwaggerEndpoint($"{description.GroupName}/swagger.json", description.GroupName.ToUpperInvariant());
+                    c.SwaggerEndpoint($"/swagger/{description.GroupName}/swagger.json", $"Version {description.GroupName}");
                 }
             });
+
+            // Separate endpoints that contain only one version
+            foreach (var description in provider.ApiVersionDescriptions)
+            {
+                app.UseSwaggerUI(c =>
+                {
+                    c.RoutePrefix = $"swagger/{description.GroupName}";
+                    c.SwaggerEndpoint($"/swagger/{description.GroupName}/swagger.json", $"Version {description.GroupName}");
+                });
+                app.UseReDoc(c =>
+                {
+                    c.RoutePrefix = $"redoc/{description.GroupName}";
+                    c.SpecUrl($"/swagger/{description.GroupName}/swagger.json");
+                });
+            }
         }
     }
 }