Move inline css and js to external files for SwaggerUI and ReDoc

src/Swashbuckle.AspNetCore.ReDoc/ReDocMiddleware.cs

@@ -53,24 +53,30 @@ public ReDocMiddleware(
         public async Task Invoke(HttpContext httpContext)
         {
             var httpMethod = httpContext.Request.Method;
-            var path = httpContext.Request.Path.Value;
 
-            // If the RoutePrefix is requested (with or without trailing slash), redirect to index URL
-            if (httpMethod == "GET" && Regex.IsMatch(path, $"^/?{Regex.Escape(_options.RoutePrefix)}/?$",  RegexOptions.IgnoreCase))
+            if (HttpMethods.IsGet(httpMethod))
             {
-                // Use relative redirect to support proxy environments
-                var relativeIndexUrl = string.IsNullOrEmpty(path) || path.EndsWith("/")
-                    ? "index.html"
-                    : $"{path.Split('/').Last()}/index.html";
+                var path = httpContext.Request.Path.Value;
 
-                RespondWithRedirect(httpContext.Response, relativeIndexUrl);
-                return;
-            }
+                // If the RoutePrefix is requested (with or without trailing slash), redirect to index URL
+                if (Regex.IsMatch(path, $"^/?{Regex.Escape(_options.RoutePrefix)}/?$", RegexOptions.IgnoreCase))
+                {
+                    // Use relative redirect to support proxy environments
+                    var relativeIndexUrl = string.IsNullOrEmpty(path) || path.EndsWith("/")
+                        ? "index.html"
+                        : $"{path.Split('/').Last()}/index.html";
 
-            if (httpMethod == "GET" && Regex.IsMatch(path, $"/{_options.RoutePrefix}/?index.html",  RegexOptions.IgnoreCase))
-            {
-                await RespondWithIndexHtml(httpContext.Response);
-                return;
+                    RespondWithRedirect(httpContext.Response, relativeIndexUrl);
+                    return;
+                }
+
+                var match = Regex.Match(path, $"^/{Regex.Escape(_options.RoutePrefix)}/?(index.(html|css|js))$", RegexOptions.IgnoreCase);
+
+                if (match.Success)
+                {
+                    await RespondWithFile(httpContext.Response, match.Groups[1].Value);
+                    return;
+                }
             }
 
             await _staticFileMiddleware.Invoke(httpContext);
@@ -97,21 +103,38 @@ private void RespondWithRedirect(HttpResponse response, string location)
             response.Headers["Location"] = location;
         }
 
-        private async Task RespondWithIndexHtml(HttpResponse response)
+        private async Task RespondWithFile(HttpResponse response, string fileName)
         {
             response.StatusCode = 200;
-            response.ContentType = "text/html";
 
-            using (var stream = _options.IndexStream())
+            Stream stream;
+
+            switch (fileName)
+            {
+                case "index.css":
+                    response.ContentType = "text/css";
+                    stream = ResourceHelper.GetEmbeddedResource(fileName);
+                    break;
+                case "index.js":
+                    response.ContentType = "application/javascript;charset=utf-8";
+                    stream = ResourceHelper.GetEmbeddedResource(fileName);
+                    break;
+                default:
+                    response.ContentType = "text/html;charset=utf-8";
+                    stream = _options.IndexStream();
+                    break;
+            }
+
+            using (stream)
             {
                 // Inject arguments before writing to response
-                var htmlBuilder = new StringBuilder(new StreamReader(stream).ReadToEnd());
+                var content = new StringBuilder(new StreamReader(stream).ReadToEnd());
                 foreach (var entry in GetIndexArguments())
                 {
-                    htmlBuilder.Replace(entry.Key, entry.Value);
+                    content.Replace(entry.Key, entry.Value);
                 }
 
-                await response.WriteAsync(htmlBuilder.ToString(), Encoding.UTF8);
+                await response.WriteAsync(content.ToString(), Encoding.UTF8);
             }
         }
 

src/Swashbuckle.AspNetCore.ReDoc/ReDocOptions.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
-using System.Reflection;
 using System.Text.Json.Serialization;
 
 namespace Swashbuckle.AspNetCore.ReDoc
@@ -16,8 +15,7 @@ public class ReDocOptions
         /// <summary>
         /// Gets or sets a Stream function for retrieving the redoc page
         /// </summary>
-        public Func<Stream> IndexStream { get; set; } = () => typeof(ReDocOptions).GetTypeInfo().Assembly
-            .GetManifestResourceStream("Swashbuckle.AspNetCore.ReDoc.index.html");
+        public Func<Stream> IndexStream { get; set; } = () => ResourceHelper.GetEmbeddedResource("index.html");
 
         /// <summary>
         /// Gets or sets a title for the redoc page
@@ -111,4 +109,4 @@ public class ConfigObject
         [JsonExtensionData]
         public Dictionary<string, object> AdditionalItems { get; set; } = new Dictionary<string, object>();
     }
-}
+}

src/Swashbuckle.AspNetCore.ReDoc/ResourceHelper.cs

@@ -0,0 +1,13 @@
+using System.IO;
+using System.Reflection;
+
+namespace Swashbuckle.AspNetCore.ReDoc;
+
+internal static class ResourceHelper
+{
+    public static Stream GetEmbeddedResource(string fileName)
+    {
+        return typeof(ResourceHelper).GetTypeInfo().Assembly
+            .GetManifestResourceStream($"Swashbuckle.AspNetCore.ReDoc.{fileName}");
+    }
+}

src/Swashbuckle.AspNetCore.ReDoc/Swashbuckle.AspNetCore.ReDoc.csproj

@@ -11,7 +11,14 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <None Remove="index.css" />
+    <None Remove="index.js" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <EmbeddedResource Include="index.css" />
     <EmbeddedResource Include="index.html" />
+    <EmbeddedResource Include="index.js" />
     <EmbeddedResource Include="node_modules/redoc/bundles/redoc.standalone.js" />
   </ItemGroup>
 

src/Swashbuckle.AspNetCore.ReDoc/index.css

@@ -0,0 +1,4 @@
+body {
+    margin: 0;
+    padding: 0;
+}

src/Swashbuckle.AspNetCore.ReDoc/index.html

@@ -10,19 +10,12 @@
     <!--
     Redoc doesn't change outer page styles
     -->
-    <style>
-        body {
-            margin: 0;
-            padding: 0;
-        }
-    </style>
+    <link href="index.css" rel="stylesheet" type="text/css">
     %(HeadContent)
 </head>
 <body>
     <div id="redoc-container"></div>
     <script src="redoc.standalone.js"></script>
-    <script type="text/javascript">
-        Redoc.init('%(SpecUrl)', JSON.parse('%(ConfigObject)'), document.getElementById('redoc-container'))
-    </script>
+    <script src="index.js"></script>
 </body>
-</html>
+</html>

src/Swashbuckle.AspNetCore.ReDoc/index.js

@@ -0,0 +1 @@
+Redoc.init('%(SpecUrl)', JSON.parse('%(ConfigObject)'), document.getElementById('redoc-container'));

src/Swashbuckle.AspNetCore.SwaggerUI/ResourceHelper.cs

@@ -0,0 +1,13 @@
+using System.IO;
+using System.Reflection;
+
+namespace Swashbuckle.AspNetCore.SwaggerUI;
+
+internal static class ResourceHelper
+{
+    public static Stream GetEmbeddedResource(string fileName)
+    {
+        return typeof(ResourceHelper).GetTypeInfo().Assembly
+            .GetManifestResourceStream($"Swashbuckle.AspNetCore.SwaggerUI.{fileName}");
+    }
+}

src/Swashbuckle.AspNetCore.SwaggerUI/SwaggerUIMiddleware.cs

@@ -64,26 +64,30 @@ public SwaggerUIMiddleware(
         public async Task Invoke(HttpContext httpContext)
         {
             var httpMethod = httpContext.Request.Method;
-            var path = httpContext.Request.Path.Value;
 
-            var isGet = HttpMethods.IsGet(httpMethod);
-
-            // If the RoutePrefix is requested (with or without trailing slash), redirect to index URL
-            if (isGet && Regex.IsMatch(path, $"^/?{Regex.Escape(_options.RoutePrefix)}/?$",  RegexOptions.IgnoreCase))
+            if (HttpMethods.IsGet(httpMethod))
             {
-                // Use relative redirect to support proxy environments
-                var relativeIndexUrl = string.IsNullOrEmpty(path) || path.EndsWith("/")
-                    ? "index.html"
-                    : $"{path.Split('/').Last()}/index.html";
+                var path = httpContext.Request.Path.Value;
 
-                RespondWithRedirect(httpContext.Response, relativeIndexUrl);
-                return;
-            }
+                // If the RoutePrefix is requested (with or without trailing slash), redirect to index URL
+                if (Regex.IsMatch(path, $"^/?{Regex.Escape(_options.RoutePrefix)}/?$", RegexOptions.IgnoreCase))
+                {
+                    // Use relative redirect to support proxy environments
+                    var relativeIndexUrl = string.IsNullOrEmpty(path) || path.EndsWith("/")
+                        ? "index.html"
+                        : $"{path.Split('/').Last()}/index.html";
 
-            if (isGet && Regex.IsMatch(path, $"^/{Regex.Escape(_options.RoutePrefix)}/?index.html$",  RegexOptions.IgnoreCase))
-            {
-                await RespondWithIndexHtml(httpContext.Response);
-                return;
+                    RespondWithRedirect(httpContext.Response, relativeIndexUrl);
+                    return;
+                }
+
+                var match = Regex.Match(path, $"^/{Regex.Escape(_options.RoutePrefix)}/?(index.(html|js))$", RegexOptions.IgnoreCase);
+
+                if (match.Success)
+                {
+                    await RespondWithFile(httpContext.Response, match.Groups[1].Value);
+                    return;
+                }
             }
 
             await _staticFileMiddleware.Invoke(httpContext);
@@ -110,23 +114,35 @@ private static void RespondWithRedirect(HttpResponse response, string location)
             response.Headers["Location"] = location;
         }
 
-        private async Task RespondWithIndexHtml(HttpResponse response)
+        private async Task RespondWithFile(HttpResponse response, string fileName)
         {
             response.StatusCode = 200;
-            response.ContentType = "text/html;charset=utf-8";
 
-            using (var stream = _options.IndexStream())
+            Stream stream;
+
+            if (fileName == "index.js")
+            {
+                response.ContentType = "application/javascript;charset=utf-8";
+                stream = ResourceHelper.GetEmbeddedResource(fileName);
+            }
+            else
+            {
+                response.ContentType = "text/html;charset=utf-8";
+                stream = _options.IndexStream();
+            }
+
+            using (stream)
             {
                 using var reader = new StreamReader(stream);
 
                 // Inject arguments before writing to response
-                var htmlBuilder = new StringBuilder(await reader.ReadToEndAsync());
+                var content = new StringBuilder(await reader.ReadToEndAsync());
                 foreach (var entry in GetIndexArguments())
                 {
-                    htmlBuilder.Replace(entry.Key, entry.Value);
+                    content.Replace(entry.Key, entry.Value);
                 }
 
-                await response.WriteAsync(htmlBuilder.ToString(), Encoding.UTF8);
+                await response.WriteAsync(content.ToString(), Encoding.UTF8);
             }
         }
 

src/Swashbuckle.AspNetCore.SwaggerUI/SwaggerUIOptions.cs

@@ -2,7 +2,6 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
-using System.Reflection;
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
@@ -18,8 +17,7 @@ public class SwaggerUIOptions
         /// <summary>
         /// Gets or sets a Stream function for retrieving the swagger-ui page
         /// </summary>
-        public Func<Stream> IndexStream { get; set; } = () => typeof(SwaggerUIOptions).GetTypeInfo().Assembly
-            .GetManifestResourceStream("Swashbuckle.AspNetCore.SwaggerUI.index.html");
+        public Func<Stream> IndexStream { get; set; } = () => ResourceHelper.GetEmbeddedResource("index.html");
 
         /// <summary>
         /// Gets or sets a title for the swagger-ui page
@@ -34,7 +32,7 @@ public class SwaggerUIOptions
         /// <summary>
         /// Gets the JavaScript config object, represented as JSON, that will be passed to the SwaggerUI
         /// </summary>
-        public ConfigObject ConfigObject  { get; set; } = new ConfigObject();
+        public ConfigObject ConfigObject { get; set; } = new ConfigObject();
 
         /// <summary>
         /// Gets the JavaScript config object, represented as JSON, that will be passed to the initOAuth method

src/Swashbuckle.AspNetCore.SwaggerUI/Swashbuckle.AspNetCore.SwaggerUI.csproj

@@ -16,7 +16,8 @@
 
   <ItemGroup>
     <EmbeddedResource Include="node_modules/swagger-ui-dist/**/*" Exclude="**/*/index.html;**/*/*.map;**/*/*.json;**/*/*.md;**/*/swagger-ui-es-*" />
-    <EmbeddedResource Include="index.html" />
+    <None Remove="index.html;index.js" />
+    <EmbeddedResource Include="index.html;index.js" />
   </ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' ">