feat: use UseSwaggerUi & SwaggerUiTheme options in configuer UseSwagg…

…erUI
atc-net · Aug 6, 2024 · 8d0a560 · 8d0a560
1 parent ff26429
commit 8d0a560
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 6 deletions.
diff --git a/docs/CodeDoc/Atc.Rest.Extended/Atc.Rest.Extended.Options.md b/docs/CodeDoc/Atc.Rest.Extended/Atc.Rest.Extended.Options.md
@@ -49,6 +49,10 @@
 
 ### Properties
 
+#### SwaggerUiTheme
+>```csharp
+>SwaggerUiTheme
+>```
 #### UseApiVersioning
 >```csharp
 >UseApiVersioning
@@ -61,4 +65,8 @@
 >```csharp
 >UseOpenApiSpec
 >```
+#### UseSwaggerUi
+>```csharp
+>UseSwaggerUi
+>```
 <hr /><div style='text-align: right'><i>Generated by MarkdownCodeDoc version 1.2</i></div>
diff --git a/docs/CodeDoc/Atc.Rest.Extended/IndexExtended.md b/docs/CodeDoc/Atc.Rest.Extended/IndexExtended.md
@@ -46,9 +46,11 @@
      - PostConfigure(string name, JwtBearerOptions options)
 - [RestApiExtendedOptions](Atc.Rest.Extended.Options.md#restapiextendedoptions)
   -  Properties
+     - SwaggerUiTheme
      - UseApiVersioning
      - UseFluentValidation
      - UseOpenApiSpec
+     - UseSwaggerUi
 
 ## [Atc.Rest.Extended.Versioning](Atc.Rest.Extended.Versioning.md)
 
@@ -64,7 +66,7 @@
 - [OpenApiBuilderExtensions](Microsoft.AspNetCore.Builder.md#openapibuilderextensions)
   -  Static Methods
      - UseOpenApiSpec(this IApplicationBuilder app, IWebHostEnvironment env)
-     - UseOpenApiSpec(this IApplicationBuilder app, IWebHostEnvironment env, RestApiExtendedOptions restApiOptions)
+     - UseOpenApiSpec(this IApplicationBuilder app, IWebHostEnvironment env, RestApiExtendedOptions restApiOptions, SwaggerUIOptions swaggerUiOption = null)
 - [RestApiExtendedBuilderExtensions](Microsoft.AspNetCore.Builder.md#restapiextendedbuilderextensions)
   -  Static Methods
      - ConfigureRestApi(this IApplicationBuilder app, IWebHostEnvironment env)

diff --git a/docs/CodeDoc/Atc.Rest.Extended/Microsoft.AspNetCore.Builder.md b/docs/CodeDoc/Atc.Rest.Extended/Microsoft.AspNetCore.Builder.md
@@ -21,7 +21,7 @@
 >```
 #### UseOpenApiSpec
 >```csharp
->IApplicationBuilder UseOpenApiSpec(this IApplicationBuilder app, IWebHostEnvironment env, RestApiExtendedOptions restApiOptions)
+>IApplicationBuilder UseOpenApiSpec(this IApplicationBuilder app, IWebHostEnvironment env, RestApiExtendedOptions restApiOptions, SwaggerUIOptions swaggerUiOption = null)
 >```
 
 <br />

diff --git a/src/Atc.Rest.Extended/Extensions/ApplicationBuilder/OpenApiBuilderExtensions.cs b/src/Atc.Rest.Extended/Extensions/ApplicationBuilder/OpenApiBuilderExtensions.cs
@@ -11,7 +11,8 @@ public static IApplicationBuilder UseOpenApiSpec(
     public static IApplicationBuilder UseOpenApiSpec(
         this IApplicationBuilder app,
         IWebHostEnvironment env,
-        RestApiExtendedOptions restApiOptions)
+        RestApiExtendedOptions restApiOptions,
+        SwaggerUIOptions? swaggerUiOption = null)
     {
         ArgumentNullException.ThrowIfNull(env);
         ArgumentNullException.ThrowIfNull(restApiOptions);
@@ -23,9 +24,16 @@ public static IApplicationBuilder UseOpenApiSpec(
 
         app.UseSwagger();
 
-        if (env.IsDevelopment())
+        if (restApiOptions.UseSwaggerUi || env.IsDevelopment())
         {
-            app.UseSwaggerUI();
+            if (swaggerUiOption is null)
+            {
+                app.UseSwaggerUI();
+            }
+            else
+            {
+                app.UseSwaggerUI(swaggerUiOption);
+            }
         }
 
         return app;

diff --git a/src/Atc.Rest.Extended/Extensions/ApplicationBuilder/RestApiExtendedBuilderExtensions.cs b/src/Atc.Rest.Extended/Extensions/ApplicationBuilder/RestApiExtendedBuilderExtensions.cs
@@ -34,7 +34,35 @@ public static IApplicationBuilder ConfigureRestApi(
         // Cast to base-restApiOptions to force to use ConfigureRestApi in RestApiBuilderExtensions
         app.ConfigureRestApi(env, restApiOptions as RestApiOptions, setupAction);
 
-        if (restApiOptions.UseOpenApiSpec)
+        if (!restApiOptions.UseOpenApiSpec)
+        {
+            return app;
+        }
+
+        if ((env.IsDevelopment() || restApiOptions.UseSwaggerUi) &&
+            restApiOptions.SwaggerUiTheme is not null)
+        {
+            var cssFile = string.Empty;
+            if (restApiOptions.SwaggerUiTheme.EndsWith(".css", StringComparison.Ordinal) &&
+                restApiOptions.SwaggerUiTheme.Contains("Light", StringComparison.OrdinalIgnoreCase))
+            {
+                cssFile = "SwaggerLight.css";
+            }
+            else if (restApiOptions.SwaggerUiTheme.EndsWith(".css", StringComparison.Ordinal) &&
+                     restApiOptions.SwaggerUiTheme.Contains("Dark", StringComparison.OrdinalIgnoreCase))
+            {
+                cssFile = "SwaggerDark.css";
+            }
+
+            var options = new SwaggerUIOptions();
+            options.InjectStylesheet(restApiOptions.SwaggerUiTheme);
+            options.EnableTryItOutByDefault();
+            options.InjectStylesheet($"/swagger-ui/{cssFile}");
+            options.InjectJavascript("/swagger-ui/main.js");
+
+            app.UseOpenApiSpec(env, restApiOptions, options);
+        }
+        else
         {
             app.UseOpenApiSpec(env, restApiOptions);
         }