Ticket #902 : Can exclude endpoints from swagger

Author: habarthierry-hue

src/IdServer/SimpleIdServer.IdServer.Swagger/Filters/ExcludeEndpointsConfig.cs

@@ -0,0 +1,9 @@
+// Copyright (c) SimpleIdServer. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace SimpleIdServer.IdServer.Swagger.Filters;
+
+public class ExcludeEndpointsConfig
+{
+    public string[] SegmentsToExclude { get; set; } = Array.Empty<string>();
+}

src/IdServer/SimpleIdServer.IdServer.Swagger/Filters/ExcludeEndpointsDocumentFilter.cs

@@ -0,0 +1,38 @@
+// Copyright (c) SimpleIdServer. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace SimpleIdServer.IdServer.Swagger.Filters;
+
+public class ExcludeEndpointsDocumentFilter : IDocumentFilter
+{
+    private readonly ExcludeEndpointsConfig _config;
+
+    public ExcludeEndpointsDocumentFilter(ExcludeEndpointsConfig config)
+    {
+        _config = config;
+    }
+
+    public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
+    {
+        if (_config.SegmentsToExclude == null || _config.SegmentsToExclude.Length == 0)
+        {
+            return;
+        }
+
+        var pathsToRemove = swaggerDoc.Paths
+            .Where(path =>
+                _config.SegmentsToExclude.Any(segment =>
+                    path.Key.TrimStart('/')
+                        .StartsWith(segment.Trim('/'), StringComparison.OrdinalIgnoreCase))
+            )
+            .Select(p => p.Key)
+            .ToList();
+
+        foreach (var path in pathsToRemove)
+        {
+            swaggerDoc.Paths.Remove(path);
+        }
+    }
+}

src/IdServer/SimpleIdServer.IdServer.Swagger/IdServerBuilderExtensions.cs

@@ -11,17 +11,22 @@ namespace Microsoft.Extensions.DependencyInjection;
 
 public static class IdServerBuilderExtensions
 {
-    public static IdServerBuilder AddSwagger(this IdServerBuilder builder, Action<IdServerSwaggerApiConfiguration> action = null)
+    public static IdServerBuilder AddSwagger(
+        this IdServerBuilder builder, 
+        Action<IdServerSwaggerApiConfiguration> action = null)
     {
+        var conf = new IdServerSwaggerApiConfiguration(builder.Services);
+        if (action != null)
+        {
+            action(conf);
+        }
+
         builder.Services.AddSwaggerGen(o =>
         {
-            o.SchemaFilter<DescribeEnumMemberValues>();
-            var conf = new IdServerSwaggerApiConfiguration(o);
+            conf.Options = o;
+            conf.Configure();
             conf.AddOAuthSecurity();
-            if(action != null)
-            {
-                action(conf);
-            }
+            o.SchemaFilter<DescribeEnumMemberValues>();
         });
         builder.Services.RemoveAll<IApiDescriptionGroupCollectionProvider>();
         builder.Services.AddSingleton<IApiDescriptionGroupCollectionProvider, SidApiDescriptionGroupCollectionProvider>();

src/IdServer/SimpleIdServer.IdServer.Swagger/IdServerSwaggerApiConfiguration.cs

@@ -2,31 +2,63 @@
 // Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.OpenApi.Models;
+using SimpleIdServer.IdServer.Swagger.Filters;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
 namespace SimpleIdServer.IdServer.Swagger;
 
 public class IdServerSwaggerApiConfiguration
 {
-    private readonly SwaggerGenOptions _options;
+    private readonly IServiceCollection _services;
+    private readonly List<string> _xmlPaths;
+    private bool _addDocumentFilter;
 
-    internal IdServerSwaggerApiConfiguration(SwaggerGenOptions options)
+    internal IdServerSwaggerApiConfiguration(IServiceCollection services)
     {
-        _options = options;
+        _services = services;
+        _xmlPaths = new List<string>();
+    }
+
+    internal SwaggerGenOptions Options
+    {
+        get; set;
     }
 
     public IdServerSwaggerApiConfiguration IncludeDocumentation<T>()
     {
         var assm = typeof(T).Assembly.ManifestModule.Name.Replace(".dll", string.Empty);
         var xmlFile = $"{assm}.xml";
         var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
-        _options.IncludeXmlComments(xmlPath);
+        _xmlPaths.Add(xmlPath);
         return this;
     }
 
+    public IdServerSwaggerApiConfiguration ExcludeDocumentations(params string[] filters)
+    {
+        _services.AddSingleton(new ExcludeEndpointsConfig
+        {
+            SegmentsToExclude = filters.ToArray()
+        });
+        _addDocumentFilter = true;
+        return this;
+    }
+
+    internal void Configure()
+    {
+        foreach(var xmlPath in _xmlPaths)
+        {
+            Options.IncludeXmlComments(xmlPath);
+        }
+
+        if(_addDocumentFilter)
+        {
+            Options.DocumentFilter<ExcludeEndpointsDocumentFilter>();
+        }
+    }
+
     internal IdServerSwaggerApiConfiguration AddOAuthSecurity()
     {
-        _options.AddSecurityDefinition("OAuth2", new OpenApiSecurityScheme
+        Options.AddSecurityDefinition("OAuth2", new OpenApiSecurityScheme
         {
             Type = SecuritySchemeType.OAuth2,
             Flows = new OpenApiOAuthFlows
@@ -58,7 +90,7 @@ internal IdServerSwaggerApiConfiguration AddOAuthSecurity()
                 }
             }
         });
-        _options.AddSecurityRequirement(new OpenApiSecurityRequirement 
+        Options.AddSecurityRequirement(new OpenApiSecurityRequirement 
         {
             {
                 new OpenApiSecurityScheme