Merge pull request #42 from wemogy/swagger/default-path

Add option to not publish swagger files

src/Wemogy.AspNet/Swagger/OpenApiConfig.cs

@@ -0,0 +1,19 @@
+using Microsoft.OpenApi.Models;
+
+namespace Wemogy.AspNet.Swagger;
+
+public class OpenApiConfig
+{
+    public OpenApiInfo OpenApiInfo { get; }
+
+    /// <summary>
+    /// Determines, if the OpenAPI specification should be published to the UI.
+    /// </summary>
+    public bool Publish { get; }
+
+    public OpenApiConfig(OpenApiInfo openApiInfo, bool publish)
+    {
+        OpenApiInfo = openApiInfo;
+        Publish = publish;
+    }
+}

src/Wemogy.AspNet/Swagger/OpenApiEnvironment.cs

@@ -11,28 +11,35 @@ public class OpenApiEnvironment
     {
         public string Version { get; }
         public string PathToXmlDocumentationFile { get; private set; }
-        public Dictionary<string, OpenApiInfo> OpenApiGroups { get; }
+        public Dictionary<string, OpenApiConfig> OpenApiGroups { get; }
         public bool RemoveDtoSuffix { get; }
         public List<Action<SwaggerGenOptions>> SwaggerGenOptions { get; }
 
         public OpenApiEnvironment(string version, string pathToXmlDocumentationFile)
         {
             Version = version;
             PathToXmlDocumentationFile = pathToXmlDocumentationFile;
-            OpenApiGroups = new Dictionary<string, OpenApiInfo>();
+            OpenApiGroups = new Dictionary<string, OpenApiConfig>();
             RemoveDtoSuffix = true;
             SwaggerGenOptions = new List<Action<SwaggerGenOptions>> { x => x.SupportNonNullableReferenceTypes() };
         }
 
-        public OpenApiEnvironment WithApiGroup(string name, string title, string description)
+        /// <summary>
+        /// Adds a new API group to the OpenAPI specification.
+        /// </summary>
+        /// <param name="name">Name of the OpenAPI spec file (no special chars)</param>
+        /// <param name="title">Title of the OpenAPI spec.</param>
+        /// <param name="description">Description of the OpenAPI spec.</param>
+        /// <param name="publish">Publish OpenAPI specification to the UI.</param>
+        public OpenApiEnvironment WithApiGroup(string name, string title, string description, bool publish = true)
         {
             var info = new OpenApiInfo
             {
                 Title = title,
                 Version = Version,
                 Description = description
             };
-            OpenApiGroups.Add(name, info);
+            OpenApiGroups.Add(name, new OpenApiConfig(info, publish));
             SwaggerGenOptions.Add(c => c.AddDefaults(name, info, PathToXmlDocumentationFile, RemoveDtoSuffix));
             return this;
         }

src/Wemogy.AspNet/Swagger/SwaggerExtensions.cs

@@ -31,7 +31,11 @@ public static void UseDefaultSwagger(this IApplicationBuilder applicationBuilder
             {
                 foreach (var group in environment.OpenApiGroups)
                 {
-                    c.SwaggerEndpoint($"/swagger/{group.Key}/swagger.json", $"{group.Value.Title} - {group.Value.Version}");
+                    // Only publish groups that are marked as publishable
+                    if (group.Value.Publish)
+                    {
+                        c.SwaggerEndpoint($"/swagger/{group.Key}/swagger.json", $"{group.Value.OpenApiInfo.Title} - {group.Value.OpenApiInfo.Version}");
+                    }
                 }
             });
         }