blocks|key|3703520|text|使用文档过滤器生成后，您可以从swagger文档中删除“操作”--只需将谓词设置为null+(不过，可能还有其他方法)|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|3703521|下面的示例只允许使用GET谓词，并且是从this+issue中获取的。|3703522|class+RemoveVerbsFilter+:+IDocumentFilter
{
++++public+void+Apply(SwaggerDocument+swaggerDoc,+SchemaRegistry+schemaRegistry,+IApiExplorer+apiExplorer)
++++{
++++++++foreach+(PathItem+path+in+swaggerDoc.paths.Values)
++++++++{
++++++++++++path.delete+=+null;
++++++++++++//path.get+=+null;+//+leaving+GET+in
++++++++++++path.head+=+null;
++++++++++++path.options+=+null;
++++++++++++path.patch+=+null;
++++++++++++path.post+=+null;
++++++++++++path.put+=+null;
++++++++}
++++}
}|code-block|syntax|javascript|3703523|在您的swagger配置中：|3703524|...EnableSwagger(conf+=>+
{
++++//+...

++++conf.DocumentFilter<RemoveVerbsFilter>();
});|3703525|entityMap|0|LINK|mutability|MUTABLE|url|https://github.com/domaindrivendev/Swashbuckle/issues/399#issuecomment-117603707^0|15|4|0|A|3|K|A|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|Y|8|@$9|Z|A|10|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|11|8|@$9|12|A|13|B|C]]|D|@$9|14|A|15|1|16]]|E|$]]|$1|H|3|I|5|J|7|17|8|@]|D|@]|E|$K|L]]|$1|M|3|N|5|6|7|18|8|@]|D|@]|E|$]]|$1|O|3|P|5|J|7|19|8|@]|D|@]|E|$K|L]]|$1|Q|3|-4|5|6|7|1A|8|@]|D|@]|E|$]]]|R|$S|$5|T|U|V|E|$W|X]]]]

You can remove "operations" from the swagger document after it's generated with a document filter - just set the verb to <code>null</code> (though, there may be other ways to do it as well)

The following sample allows only <code>GET</code> verbs - and is taken from <a href="https://github.com/domaindrivendev/Swashbuckle/issues/399#issuecomment-117603707">this issue</a>.

<pre><code>class RemoveVerbsFilter : IDocumentFilter
{
 public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
 {
 foreach (PathItem path in swaggerDoc.paths.Values)
 {
 path.delete = null;
 //path.get = null; // leaving GET in
 path.head = null;
 path.options = null;
 path.patch = null;
 path.post = null;
 path.put = null;
 }
 }
}
</code></pre>

and in your swagger config:

<pre><code>...EnableSwagger(conf =&gt; 
{
 // ...

 conf.DocumentFilter&lt;RemoveVerbsFilter&gt;();
});
</code></pre>

blocks|key|4197588|text|我倾向于完全删除路径项的字典条目：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4197589|var+pathsToRemove+=+swaggerDoc.Paths
++++++++++++++++.Where(pathItem+=>+!pathItem.Key.Contains("api/"))
++++++++++++++++.ToList();

foreach+(var+item+in+pathsToRemove)
{
++++swaggerDoc.Paths.Remove(item.Key);
}|code-block|syntax|javascript|4197590|使用这种方法，您将不会在生成的swagger.json定义中获得“空”项。|4197591|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|K|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|L|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|M|8|@]|9|@]|A|$]]|$1|I|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|J|$]]

I would prefer to remove the dictionary entries for path items completely: 

<pre><code>var pathsToRemove = swaggerDoc.Paths
 .Where(pathItem =&gt; !pathItem.Key.Contains("api/"))
 .ToList();

foreach (var item in pathsToRemove)
{
 swaggerDoc.Paths.Remove(item.Key);
}
</code></pre>

With this approach, you would not get "empty" items in the generated swagger.json definition.

blocks|key|3703558|text|可以将以下属性添加到控制器和操作中，以将它们从生成的文档中排除在外：[ApiExplorerSettings(IgnoreApi+=+true)]|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|3703559|entityMap^0|Y|13|0^^$0|@$1|2|3|4|5|6|7|H|8|@$9|I|A|J|B|C]]|D|@]|E|$]]|$1|F|3|-4|5|6|7|K|8|@]|D|@]|E|$]]]|G|$]]

You can add the following attribute to Controllers and Actions to exclude them from the generated documentation: <code>[ApiExplorerSettings(IgnoreApi = true)]</code>

blocks|key|3703584|text|有人在github上发布了解决方案，所以我要把它粘贴在这里。所有的功劳都归他。https://github.com/domaindrivendev/Swashbuckle/issues/153#issuecomment-213342771|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|3703585|首先创建一个属性类|3703586|[AttributeUsage(AttributeTargets.Method+%7C+AttributeTargets.Class)]
public+class+HideInDocsAttribute+:+Attribute
{
}|code-block|syntax|javascript|3703587|然后创建文档筛选器类。|3703588|public+class+HideInDocsFilter+:+IDocumentFilter
{
++++public+void+Apply(SwaggerDocument+swaggerDoc,+SchemaRegistry+schemaRegistry,+IApiExplorer+apiExplorer)
++++{
++++++++foreach+(var+apiDescription+in+apiExplorer.ApiDescriptions)
++++++++{
++++++++++++if+(!apiDescription.ActionDescriptor.ControllerDescriptor.GetCustomAttributes<HideInDocsAttribute>().Any()+&&+!apiDescription.ActionDescriptor.GetCustomAttributes<HideInDocsAttribute>().Any())+continue;
++++++++++++var+route+=+"/"+%2B+apiDescription.Route.RouteTemplate.TrimEnd('/');
++++++++++++swaggerDoc.paths.Remove(route);
++++++++}
++++}
}|3703589|然后在Swagger类中，添加文档过滤器|3703590|public+class+SwaggerConfig
{
++++public+static+void+Register(HttpConfiguration+config)
++++{
++++++++var+thisAssembly+=+typeof(SwaggerConfig).Assembly;

++++++++config
+++++++++++++.EnableSwagger(c+=>
++++++++++++++++{
++++++++++++++++++++...+++++++++++++++++++++++
++++++++++++++++++++c.DocumentFilter<HideInDocsFilter>();
++++++++++++++++++++...
++++++++++++++++})
++++++++++++.EnableSwaggerUi(c+=>
++++++++++++++++{
++++++++++++++++++++...
++++++++++++++++});
++++}
}|3703591|最后一步是在Controller或方法上添加HideInDocsAttribute属性，您不希望Swashbuckle生成文档。|3703592|entityMap|0|LINK|mutability|MUTABLE|url|https://github.com/domaindrivendev/Swashbuckle/issues/153#issuecomment-213342771^0|13|28|0|0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|12|8|@]|9|@$A|13|B|14|1|15]]|C|$]]|$1|D|3|E|5|6|7|16|8|@]|9|@]|C|$]]|$1|F|3|G|5|H|7|17|8|@]|9|@]|C|$I|J]]|$1|K|3|L|5|6|7|18|8|@]|9|@]|C|$]]|$1|M|3|N|5|H|7|19|8|@]|9|@]|C|$I|J]]|$1|O|3|P|5|6|7|1A|8|@]|9|@]|C|$]]|$1|Q|3|R|5|H|7|1B|8|@]|9|@]|C|$I|J]]|$1|S|3|T|5|6|7|1C|8|@]|9|@]|C|$]]|$1|U|3|-4|5|6|7|1D|8|@]|9|@]|C|$]]]|V|$W|$5|X|Y|Z|C|$10|11]]]]

Someone posted the solution on github so I'm going to paste it here. All credits goes to him. <a href="https://github.com/domaindrivendev/Swashbuckle/issues/153#issuecomment-213342771" rel="noreferrer">https://github.com/domaindrivendev/Swashbuckle/issues/153#issuecomment-213342771</a>

Create first an Attribute class

<pre><code>[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class HideInDocsAttribute : Attribute
{
}
</code></pre>

Then create a Document Filter class

<pre><code>public class HideInDocsFilter : IDocumentFilter
{
 public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
 {
 foreach (var apiDescription in apiExplorer.ApiDescriptions)
 {
 if (!apiDescription.ActionDescriptor.ControllerDescriptor.GetCustomAttributes&lt;HideInDocsAttribute&gt;().Any() &amp;&amp; !apiDescription.ActionDescriptor.GetCustomAttributes&lt;HideInDocsAttribute&gt;().Any()) continue;
 var route = "/" + apiDescription.Route.RouteTemplate.TrimEnd('/');
 swaggerDoc.paths.Remove(route);
 }
 }
}
</code></pre>

Then in Swagger Config class, add that document filter

<pre><code>public class SwaggerConfig
{
 public static void Register(HttpConfiguration config)
 {
 var thisAssembly = typeof(SwaggerConfig).Assembly;

 config
 .EnableSwagger(c =&gt;
 {
 ... 
 c.DocumentFilter&lt;HideInDocsFilter&gt;();
 ...
 })
 .EnableSwaggerUi(c =&gt;
 {
 ...
 });
 }
}
</code></pre>

Last step is to add [HideInDocsAttribute] attribute on the Controller or Method you don't want Swashbuckle to generate documentation.

blocks|key|3703607|text|基于@spottedmahns+answer。我的任务反之亦然。只显示那些被允许的。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|3703608|框架：.NetCore+2.1；Swagger:+3.0.0|3703609|添加属性|3703610|[AttributeUsage(AttributeTargets.Method+%7C+AttributeTargets.Class)]
public+class+ShowInSwaggerAttribute+:+Attribute
{
}|code-block|syntax|javascript|3703611|并实现自定义IDocumentFilter|style|BOLD|3703612|public+class+ShowInSwaggerFilter+:+IDocumentFilter
{
++++public+void+Apply(SwaggerDocument+swaggerDoc,+DocumentFilterContext+context)
++++{

++++++++foreach+(var+contextApiDescription+in+context.ApiDescriptions)
++++++++{
++++++++++++var+actionDescriptor+=+(ControllerActionDescriptor)+contextApiDescription.ActionDescriptor;

++++++++++++if+(actionDescriptor.ControllerTypeInfo.GetCustomAttributes<ShowInSwaggerAttribute>().Any()+%7C%7C
++++++++++++++++actionDescriptor.MethodInfo.GetCustomAttributes<ShowInSwaggerAttribute>().Any())
++++++++++++{
++++++++++++++++continue;
++++++++++++}
++++++++++++else
++++++++++++{
++++++++++++++++var+key+=+"/"+%2B+contextApiDescription.RelativePath.TrimEnd('/');
++++++++++++++++var+pathItem+=+swaggerDoc.Paths[key];
++++++++++++++++if(pathItem+==+null)
++++++++++++++++++++continue;

++++++++++++++++switch+(contextApiDescription.HttpMethod.ToUpper())
++++++++++++++++{
++++++++++++++++++++case+"GET":
++++++++++++++++++++++++pathItem.Get+=+null;
++++++++++++++++++++++++break;
++++++++++++++++++++case+"POST":
++++++++++++++++++++++++pathItem.Post+=+null;
++++++++++++++++++++++++break;
++++++++++++++++++++case+"PUT":
++++++++++++++++++++++++pathItem.Put+=+null;
++++++++++++++++++++++++break;
++++++++++++++++++++case+"DELETE":
++++++++++++++++++++++++pathItem.Delete+=+null;
++++++++++++++++++++++++break;
++++++++++++++++}

++++++++++++++++if+(pathItem.Get+==+null++//+ignore+other+methods
++++++++++++++++++++&&+pathItem.Post+==+null+
++++++++++++++++++++&&+pathItem.Put+==+null+
++++++++++++++++++++&&+pathItem.Delete+==+null)
++++++++++++++++++++swaggerDoc.Paths.Remove(key);
++++++++++++}
++++++++}
++++}
}|3703613|ConfigureServices代码：|3703614|public+void+ConfigureServices(IServiceCollection+services)
{
+++++//+other+code

++++services.AddSwaggerGen(c+=>
++++{
++++++++//+other+configurations
++++++++c.DocumentFilter<ShowInSwaggerFilter>();
++++});
}|3703615|entityMap|0|LINK|mutability|MUTABLE|url|https://stackoverflow.com/a/42235291/1235390^0|G|6|0|0|0|0|0|6|F|0|0|0|H|0|0^^$0|@$1|2|3|4|5|6|7|14|8|@]|9|@$A|15|B|16|1|17]]|C|$]]|$1|D|3|E|5|6|7|18|8|@]|9|@]|C|$]]|$1|F|3|G|5|6|7|19|8|@]|9|@]|C|$]]|$1|H|3|I|5|J|7|1A|8|@]|9|@]|C|$K|L]]|$1|M|3|N|5|6|7|1B|8|@$A|1C|B|1D|O|P]]|9|@]|C|$]]|$1|Q|3|R|5|J|7|1E|8|@]|9|@]|C|$K|L]]|$1|S|3|T|5|6|7|1F|8|@$A|1G|B|1H|O|P]]|9|@]|C|$]]|$1|U|3|V|5|J|7|1I|8|@]|9|@]|C|$K|L]]|$1|W|3|-4|5|6|7|1J|8|@]|9|@]|C|$]]]|X|$Y|$5|Z|10|11|C|$12|13]]]]

Based on @spottedmahns <a href="https://stackoverflow.com/a/42235291/1235390">answer</a>.
My task was vice versa. Show only those that are allowed.

Frameworks: .NetCore 2.1; Swagger: 3.0.0

Added attribute 

<pre><code>[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class ShowInSwaggerAttribute : Attribute
{
}
</code></pre>

And implement custom IDocumentFilter

<pre><code>public class ShowInSwaggerFilter : IDocumentFilter
{
 public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
 {

 foreach (var contextApiDescription in context.ApiDescriptions)
 {
 var actionDescriptor = (ControllerActionDescriptor) contextApiDescription.ActionDescriptor;

 if (actionDescriptor.ControllerTypeInfo.GetCustomAttributes&lt;ShowInSwaggerAttribute&gt;().Any() ||
 actionDescriptor.MethodInfo.GetCustomAttributes&lt;ShowInSwaggerAttribute&gt;().Any())
 {
 continue;
 }
 else
 {
 var key = "/" + contextApiDescription.RelativePath.TrimEnd('/');
 var pathItem = swaggerDoc.Paths[key];
 if(pathItem == null)
 continue;

 switch (contextApiDescription.HttpMethod.ToUpper())
 {
 case "GET":
 pathItem.Get = null;
 break;
 case "POST":
 pathItem.Post = null;
 break;
 case "PUT":
 pathItem.Put = null;
 break;
 case "DELETE":
 pathItem.Delete = null;
 break;
 }

 if (pathItem.Get == null // ignore other methods
 &amp;&amp; pathItem.Post == null 
 &amp;&amp; pathItem.Put == null 
 &amp;&amp; pathItem.Delete == null)
 swaggerDoc.Paths.Remove(key);
 }
 }
 }
}
</code></pre>

ConfigureServices code:

<pre><code>public void ConfigureServices(IServiceCollection services)
{
 // other code

 services.AddSwaggerGen(c =&gt;
 {
 // other configurations
 c.DocumentFilter&lt;ShowInSwaggerFilter&gt;();
 });
}
</code></pre>

blocks|key|563623|text|做一个过滤器|type|unstyled|depth|inlineStyleRanges|entityRanges|data|563624|public+class+SwaggerTagFilter+:+IDocumentFilter
{
++++public+void+Apply(SwaggerDocument+swaggerDoc,+DocumentFilterContext+context)
++++{
++++++++foreach(var+contextApiDescription+in+context.ApiDescriptions)
++++++++{
++++++++++++var+actionDescriptor+=+(ControllerActionDescriptor)contextApiDescription.ActionDescriptor;
++++++++++++
++++++++++++if(!actionDescriptor.ControllerTypeInfo.GetCustomAttributes<SwaggerTagAttribute>().Any()+&&+
+++++++++++++++!actionDescriptor.MethodInfo.GetCustomAttributes<SwaggerTagAttribute>().Any())
++++++++++++{
++++++++++++++++var+key+=+"/"+%2B+contextApiDescription.RelativePath.TrimEnd('/');
++++++++++++++++swaggerDoc.Paths.Remove(key);
++++++++++++}
++++++++}
++++}
}|code-block|syntax|javascript|563625|创建一个属性|563626|[AttributeUsage(AttributeTargets.Method+%7C+AttributeTargets.Class)]
public+class+SwaggerTagAttribute+:+Attribute
{
}|563627|应用于startup.cs|563628|services.AddSwaggerGen(c+=>+{
++++c.SwaggerDoc(1,+new+Info+{+Title+=+"API_NAME",+Version+=+"API_VERSION"+});
++++c.DocumentFilter<SwaggerTagFilter>();+//+[SwaggerTag]
});|563629|将SwaggerTag属性添加到您希望包含在Swagger中的方法和控制器中|563630|entityMap^0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|S|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|T|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|U|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|V|8|@]|9|@]|A|$E|F]]|$1|K|3|L|5|6|7|W|8|@]|9|@]|A|$]]|$1|M|3|N|5|D|7|X|8|@]|9|@]|A|$E|F]]|$1|O|3|P|5|6|7|Y|8|@]|9|@]|A|$]]|$1|Q|3|-4|5|6|7|Z|8|@]|9|@]|A|$]]]|R|$]]

Make a filter
<pre class="lang-cs prettyprint-override"><code>public class SwaggerTagFilter : IDocumentFilter
{
 public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
 {
 foreach(var contextApiDescription in context.ApiDescriptions)
 {
 var actionDescriptor = (ControllerActionDescriptor)contextApiDescription.ActionDescriptor;
 
 if(!actionDescriptor.ControllerTypeInfo.GetCustomAttributes&lt;SwaggerTagAttribute&gt;().Any() &amp;&amp; 
 !actionDescriptor.MethodInfo.GetCustomAttributes&lt;SwaggerTagAttribute&gt;().Any())
 {
 var key = &quot;/&quot; + contextApiDescription.RelativePath.TrimEnd('/');
 swaggerDoc.Paths.Remove(key);
 }
 }
 }
}
</code></pre>
Make an attribute
<pre class="lang-cs prettyprint-override"><code>[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class SwaggerTagAttribute : Attribute
{
}
</code></pre>
Apply in startup.cs
<pre class="lang-cs prettyprint-override"><code>services.AddSwaggerGen(c =&gt; {
 c.SwaggerDoc(1, new Info { Title = &quot;API_NAME&quot;, Version = &quot;API_VERSION&quot; });
 c.DocumentFilter&lt;SwaggerTagFilter&gt;(); // [SwaggerTag]
});
</code></pre>
Add [SwaggerTag] attribute to methods and controllers you want to include in Swagger JSON

blocks|key|561846|text|向SwaggerConfig中添加一行|type|unstyled|depth|inlineStyleRanges|entityRanges|data|561847|c.DocumentFilter<HideInDocsFilter>();

...

public+class+HideInDocsFilter+:+IDocumentFilter
{
++++public+void+Apply(SwaggerDocument+swaggerDoc,+SchemaRegistry+schemaRegistry,+IApiExplorer+apiExplorer)
++++{+
++++++++var+pathsToRemove+=+swaggerDoc.Paths
++++++++++++.Where(pathItem+=>+!pathItem.Key.Contains("api/"))
++++++++++++.ToList();
++++
++++++++foreach+(var+item+in+pathsToRemove)
++++++++{
++++++++++++swaggerDoc.Paths.Remove(item.Key);
++++++++}
++++}
}|code-block|syntax|javascript|561848|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

Add one line to the SwaggerConfig
<pre class="lang-cs prettyprint-override"><code>c.DocumentFilter&lt;HideInDocsFilter&gt;();

...

public class HideInDocsFilter : IDocumentFilter
{
 public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
 { 
 var pathsToRemove = swaggerDoc.Paths
 .Where(pathItem =&gt; !pathItem.Key.Contains(&quot;api/&quot;))
 .ToList();
 
 foreach (var item in pathsToRemove)
 {
 swaggerDoc.Paths.Remove(item.Key);
 }
 }
}
</code></pre>

blocks|key|563645|text|可能对某人有帮助，但在开发(调试)期间，我们喜欢公开整个控制器和/或操作，然后在生产过程中隐藏这些操作(发布版本)。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|563646|#if+DEBUG
++++[ApiExplorerSettings(IgnoreApi+=+false)]
#else
++++[ApiExplorerSettings(IgnoreApi+=+true)]
#endif++|code-block|syntax|javascript|563647|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

May help somebody but during development (debugging) we like to expose whole Controllers and/or Actions and then hide these during production (release build) 

<pre><code>#if DEBUG
 [ApiExplorerSettings(IgnoreApi = false)]
#else
 [ApiExplorerSettings(IgnoreApi = true)]
#endif 
</code></pre>

blocks|key|561876|text|与@aleha一样，我希望默认情况下排除它，这样我就不会意外地公开一个端点(默认情况下是安全的)，而是使用使用OpenApiDocument的较新版本的Swagger。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|561877|创建一个ShowInSwagger属性|561878|[AttributeUsage(AttributeTargets.Method+%7C+AttributeTargets.Class)]
public+class+ShowInSwaggerAttribute+:+Attribute
{}|code-block|syntax|javascript|561879|然后创建文档筛选器。|561880|using+Microsoft.AspNetCore.Mvc.Controllers;
using+Microsoft.OpenApi.Models;
using+Swashbuckle.AspNetCore.SwaggerGen;
using+System.Reflection;
using+System;
using+System.Linq;
using+TLS.Common.Attributes;

namespace+TLS.Common.Filters
{
++++public+class+ShowInSwaggerFilter+:+IDocumentFilter
++++{
++++++++public+void+Apply(OpenApiDocument+swaggerDoc,+DocumentFilterContext+context)
++++++++{
++++++++++++foreach+(var+contextApiDescription+in+context.ApiDescriptions)
++++++++++++{
++++++++++++++++var+actionDescriptor+=+(ControllerActionDescriptor)contextApiDescription.ActionDescriptor;

++++++++++++++++if+(actionDescriptor.ControllerTypeInfo.GetCustomAttributes<ShowInSwaggerAttribute>().Any()+%7C%7C
++++++++++++++++++++actionDescriptor.MethodInfo.GetCustomAttributes<ShowInSwaggerAttribute>().Any())
++++++++++++++++{
++++++++++++++++++++continue;
++++++++++++++++}
++++++++++++++++else
++++++++++++++++{
++++++++++++++++++++var+key+=+"/"+%2B+contextApiDescription.RelativePath.TrimEnd('/');
++++++++++++++++++++var+operation+=+(OperationType)Enum.Parse(typeof(OperationType),+contextApiDescription.HttpMethod,+true);

++++++++++++++++++++swaggerDoc.Paths[key].Operations.Remove(operation);

++++++++++++++++++++//+drop+the+entire+route+of+there+are+no+operations+left
++++++++++++++++++++if+(!swaggerDoc.Paths[key].Operations.Any())
++++++++++++++++++++{
++++++++++++++++++++++++swaggerDoc.Paths.Remove(key);
++++++++++++++++++++}
++++++++++++++++}
++++++++++++}
++++++++}
++++}
}|561881|然后在您的startup.cs或ConfigureServices中：|561882|public+void+ConfigureServices(IServiceCollection+services)
{
+++++//+other+code

++++services.AddSwaggerGen(c+=>
++++{
++++++++c.DocumentFilter<ShowInSwaggerFilter>();
++++++++//+other+config
++++});
}|561883|entityMap^0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|S|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|T|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|U|8|@]|9|@]|A|$G|H]]|$1|I|3|J|5|6|7|V|8|@]|9|@]|A|$]]|$1|K|3|L|5|F|7|W|8|@]|9|@]|A|$G|H]]|$1|M|3|N|5|6|7|X|8|@]|9|@]|A|$]]|$1|O|3|P|5|F|7|Y|8|@]|9|@]|A|$G|H]]|$1|Q|3|-4|5|6|7|Z|8|@]|9|@]|A|$]]]|R|$]]

Like @aleha I wanted to exclude by default so that I didn't accidentally expose an endpoint by accident (secure by default) but was using a newer version of the Swagger that uses OpenApiDocument.
Create a ShowInSwagger Attribute
<pre><code>[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class ShowInSwaggerAttribute : Attribute
{}
</code></pre>
Then create a Document Filter
<pre><code>using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Reflection;
using System;
using System.Linq;
using TLS.Common.Attributes;

namespace TLS.Common.Filters
{
 public class ShowInSwaggerFilter : IDocumentFilter
 {
 public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
 {
 foreach (var contextApiDescription in context.ApiDescriptions)
 {
 var actionDescriptor = (ControllerActionDescriptor)contextApiDescription.ActionDescriptor;

 if (actionDescriptor.ControllerTypeInfo.GetCustomAttributes&lt;ShowInSwaggerAttribute&gt;().Any() ||
 actionDescriptor.MethodInfo.GetCustomAttributes&lt;ShowInSwaggerAttribute&gt;().Any())
 {
 continue;
 }
 else
 {
 var key = &quot;/&quot; + contextApiDescription.RelativePath.TrimEnd('/');
 var operation = (OperationType)Enum.Parse(typeof(OperationType), contextApiDescription.HttpMethod, true);

 swaggerDoc.Paths[key].Operations.Remove(operation);

 // drop the entire route of there are no operations left
 if (!swaggerDoc.Paths[key].Operations.Any())
 {
 swaggerDoc.Paths.Remove(key);
 }
 }
 }
 }
 }
}
</code></pre>
then in your startup.cs or ConfigureServices:
<pre><code>public void ConfigureServices(IServiceCollection services)
{
 // other code

 services.AddSwaggerGen(c =&gt;
 {
 c.DocumentFilter&lt;ShowInSwaggerFilter&gt;();
 // other config
 });
}
</code></pre>

blocks|key|561895|text|您可以在Controller和方法级别创建自定义筛选器。因此，任何带有属性的Controller/方法都可以在Swagger中使用。此筛选器还从文档中删除了重复的HTTP谓词(在本例中，我只为GET/PUT/POST/修补程序而设置)，但是，您始终可以根据需要进行自定义。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|561896|属性|561897|[AttributeUsage(AttributeTargets.Method+%7C+AttributeTargets.Class)]
public+class+PublicApi:Attribute
{

}|code-block|syntax|javascript|561898|文档过滤器|561899|public+class+PublicApiFilter+:+IDocumentFilter
{
++++public+void+Apply(SwaggerDocument+swaggerDoc,+SchemaRegistry+schemaRegistry,+IApiExplorer+apiExplorer)
++++{

++++++++var+publicPaths+=+new+List<string>+{"/api"};

++++++++var+publicApiDescriptions+=+new+List<ApiDescription>();

++++++++var+publicMethods+=+FilterByPublicControllers(swaggerDoc,+apiExplorer,+publicPaths,+publicApiDescriptions);

++++++++FilterByPublicActions(swaggerDoc,+publicApiDescriptions,+publicMethods);
++++}

++++private+static+Dictionary<string,+List<string>>+FilterByPublicControllers(SwaggerDocument+swaggerDoc,+IApiExplorer+apiExplorer,+List<string>+publicPaths,+List<ApiDescription>+publicApiDescriptions)
++++{
++++++++var+publicMethods+=+new+Dictionary<string,+List<string>>();
++++++++foreach+(var+apiDescription+in+apiExplorer.ApiDescriptions)
++++++++{
++++++++++++var+isPublicApiController+=+apiDescription.ActionDescriptor.ControllerDescriptor.GetCustomAttributes<PublicApi>().Any();
++++++++++++var+isPublicApiMethod+=+apiDescription.ActionDescriptor.GetCustomAttributes<PublicApi>().Any();


++++++++++++if+(!isPublicApiController+&&+!isPublicApiMethod)
++++++++++++{
++++++++++++++++continue;
++++++++++++}

++++++++++++var+relativePath+=+ToRelativePath(apiDescription);

++++++++++++publicPaths.Add(relativePath);
++++++++++++publicApiDescriptions.Add(apiDescription);

++++++++++++var+action+=+apiDescription.ActionDescriptor.ActionName;
++++++++++++List<string>+available+=+null;
++++++++++++if+(!publicMethods.TryGetValue(relativePath,+out+available))
++++++++++++++++publicMethods[relativePath]+=+new+List<string>();
++++++++++++publicMethods[relativePath].Add(action);
++++++++}

++++++++swaggerDoc.paths+=+swaggerDoc.paths.Where(pair+=>+publicPaths.Contains(pair.Key))
++++++++++++.ToDictionary(pair+=>+pair.Key,
++++++++++++++++pair+=>+pair.Value);
++++++++return+publicMethods;
++++}

++++private+static+void+FilterByPublicActions(SwaggerDocument+swaggerDoc,+List<ApiDescription>+publicApis,+Dictionary<string,+List<string>>+publicMethods)
++++{
++++++++foreach+(var+api+in+publicApis)
++++++++{
++++++++++++var+relativePath+=+ToRelativePath(api);
++++++++++++var+availableActions+=+publicMethods[relativePath];
++++++++++++if+(availableActions+==+null)
++++++++++++{
++++++++++++++++continue;
++++++++++++}

++++++++++++foreach+(var+path+in+swaggerDoc.paths.Where(pair+=>+pair.Key.IndexOf(relativePath)+>+-1).ToList())
++++++++++++{
++++++++++++++++if+(!availableActions.Contains("Get"))
++++++++++++++++++++path.Value.get+=+null;
++++++++++++++++if+(!availableActions.Contains("Post"))
++++++++++++++++++++path.Value.post+=+null;
++++++++++++++++if+(!availableActions.Contains("Put"))
++++++++++++++++++++path.Value.put+=+null;
++++++++++++++++if+(!availableActions.Contains("Patch"))
++++++++++++++++++++path.Value.patch+=+null;
++++++++++++}
++++++++}
++++}

++++private+static+string+ToRelativePath(ApiDescription+apiDescription)
++++{
++++++++return+"/"+%2B+apiDescription.RelativePath.Substring(0,apiDescription.RelativePath.LastIndexOf('/'));
++++}
}|561900|最后，注册您的SwaggerConfig|561901|public+class+SwaggerConfig
{
++++public+static+void+Register()
++++{

++++++++var+thisAssembly+=+typeof(SwaggerConfig).Assembly;
++++++++GlobalConfiguration.Configuration
++++++++++++.EnableSwagger(c+=>
++++++++++++++++{
++++++++++++++++++++c.SingleApiVersion("v1",+"Reports");
++++++++++++++++++++c.ResolveConflictingActions(apiDescriptions+=>+apiDescriptions.First());
++++++++++++++++++++c.DocumentFilter<PublicApiFilter>();
++++++++++++++++})
++++++++++++.EnableSwaggerUi(c+=>
++++++++++++++++{

++++++++++++++++});

++++}
}|561902|示例|offset|length|style|BOLD|561903|控制器|561904|[PublicApi]
public+class+ProfileController+:+ApiController|561905|方法|561906|+public+class+UserController+:+ApiController
+{
++++[PublicApi]
++++public+ResUsers+Get(string+sessionKey,+int+userId,+int+groupId)+{
++++++++return+Get(sessionKey,+userId,+groupId,+0);
++++}|561907|entityMap^0|0|0|0|0|0|0|0|0|2|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|16|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|17|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|18|8|@]|9|@]|A|$G|H]]|$1|I|3|J|5|6|7|19|8|@]|9|@]|A|$]]|$1|K|3|L|5|F|7|1A|8|@]|9|@]|A|$G|H]]|$1|M|3|N|5|6|7|1B|8|@]|9|@]|A|$]]|$1|O|3|P|5|F|7|1C|8|@]|9|@]|A|$G|H]]|$1|Q|3|R|5|6|7|1D|8|@$S|1E|T|1F|U|V]]|9|@]|A|$]]|$1|W|3|X|5|6|7|1G|8|@]|9|@]|A|$]]|$1|Y|3|Z|5|F|7|1H|8|@]|9|@]|A|$G|H]]|$1|10|3|11|5|6|7|1I|8|@]|9|@]|A|$]]|$1|12|3|13|5|F|7|1J|8|@]|9|@]|A|$G|H]]|$1|14|3|-4|5|6|7|1K|8|@]|9|@]|A|$]]]|15|$]]

You can create a custom filter at both Controller and Method level. So any Controller/Method with your attribute will be available in the Swagger doc. This filter also removed the duplicate HTTP verbs from your document (in this example I make it for GET/PUT/POST/PATCH only), however, you can always customize per your requirement
The attribute
<pre><code>[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class PublicApi:Attribute
{

}
</code></pre>
Document filter
<pre><code>public class PublicApiFilter : IDocumentFilter
{
 public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
 {

 var publicPaths = new List&lt;string&gt; {&quot;/api&quot;};

 var publicApiDescriptions = new List&lt;ApiDescription&gt;();

 var publicMethods = FilterByPublicControllers(swaggerDoc, apiExplorer, publicPaths, publicApiDescriptions);

 FilterByPublicActions(swaggerDoc, publicApiDescriptions, publicMethods);
 }

 private static Dictionary&lt;string, List&lt;string&gt;&gt; FilterByPublicControllers(SwaggerDocument swaggerDoc, IApiExplorer apiExplorer, List&lt;string&gt; publicPaths, List&lt;ApiDescription&gt; publicApiDescriptions)
 {
 var publicMethods = new Dictionary&lt;string, List&lt;string&gt;&gt;();
 foreach (var apiDescription in apiExplorer.ApiDescriptions)
 {
 var isPublicApiController = apiDescription.ActionDescriptor.ControllerDescriptor.GetCustomAttributes&lt;PublicApi&gt;().Any();
 var isPublicApiMethod = apiDescription.ActionDescriptor.GetCustomAttributes&lt;PublicApi&gt;().Any();


 if (!isPublicApiController &amp;&amp; !isPublicApiMethod)
 {
 continue;
 }

 var relativePath = ToRelativePath(apiDescription);

 publicPaths.Add(relativePath);
 publicApiDescriptions.Add(apiDescription);

 var action = apiDescription.ActionDescriptor.ActionName;
 List&lt;string&gt; available = null;
 if (!publicMethods.TryGetValue(relativePath, out available))
 publicMethods[relativePath] = new List&lt;string&gt;();
 publicMethods[relativePath].Add(action);
 }

 swaggerDoc.paths = swaggerDoc.paths.Where(pair =&gt; publicPaths.Contains(pair.Key))
 .ToDictionary(pair =&gt; pair.Key,
 pair =&gt; pair.Value);
 return publicMethods;
 }

 private static void FilterByPublicActions(SwaggerDocument swaggerDoc, List&lt;ApiDescription&gt; publicApis, Dictionary&lt;string, List&lt;string&gt;&gt; publicMethods)
 {
 foreach (var api in publicApis)
 {
 var relativePath = ToRelativePath(api);
 var availableActions = publicMethods[relativePath];
 if (availableActions == null)
 {
 continue;
 }

 foreach (var path in swaggerDoc.paths.Where(pair =&gt; pair.Key.IndexOf(relativePath) &gt; -1).ToList())
 {
 if (!availableActions.Contains(&quot;Get&quot;))
 path.Value.get = null;
 if (!availableActions.Contains(&quot;Post&quot;))
 path.Value.post = null;
 if (!availableActions.Contains(&quot;Put&quot;))
 path.Value.put = null;
 if (!availableActions.Contains(&quot;Patch&quot;))
 path.Value.patch = null;
 }
 }
 }

 private static string ToRelativePath(ApiDescription apiDescription)
 {
 return &quot;/&quot; + apiDescription.RelativePath.Substring(0,apiDescription.RelativePath.LastIndexOf('/'));
 }
}
</code></pre>
And finally, register your SwaggerConfig
<pre><code>public class SwaggerConfig
{
 public static void Register()
 {

 var thisAssembly = typeof(SwaggerConfig).Assembly;
 GlobalConfiguration.Configuration
 .EnableSwagger(c =&gt;
 {
 c.SingleApiVersion(&quot;v1&quot;, &quot;Reports&quot;);
 c.ResolveConflictingActions(apiDescriptions =&gt; apiDescriptions.First());
 c.DocumentFilter&lt;PublicApiFilter&gt;();
 })
 .EnableSwaggerUi(c =&gt;
 {

 });

 }
}
</code></pre>
Examples
Controller
<pre><code>[PublicApi]
public class ProfileController : ApiController
</code></pre>
Method
<pre><code> public class UserController : ApiController
 {
 [PublicApi]
 public ResUsers Get(string sessionKey, int userId, int groupId) {
 return Get(sessionKey, userId, groupId, 0);
 }
</code></pre>

blocks|key|3703753|text|如果您正在使用最小的API，您可以使用：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3703754|app.MapGet("/hello",+()+=>+"Hello+World!").ExcludeFromDescription();|code-block|syntax|javascript|3703755|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

If you are using the minimal API you can use:
<pre class="lang-cs prettyprint-override"><code>app.MapGet(&quot;/hello&quot;, () =&gt; &quot;Hello World!&quot;).ExcludeFromDescription();
</code></pre>

I have a C# ASP.NET WebAPI application with API documentation being automatically generated using <a href="https://github.com/domaindrivendev/Swashbuckle" rel="noreferrer">Swashbuckle</a>. I want to be able to omit certain methods from the documentation but I can't seem to work out how to tell Swagger not to include them in the Swagger UI output.
I sense it is something to do with adding a model or schema filter but it isn't obvious what to do and the documentation only seems to provide examples of how to modify the output for a method, not remove it completely from the output.

How to omit methods from Swagger documentation on WebAPI using Swashbuckle

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

我有一个C# ASP.NET WebAPI应用程序，它使用自动生成API文档。我希望能够从文档中省略某些方法，但我似乎不知道如何告诉Swagger不要将它们包含在Swagger输出中。我感觉到这与添加模型或模式筛选器有关，但不清楚该做什么，文档似乎只提供了如何为方法修改输出的示例，而不是从输出中完全删除它。

问如何使用Swashbuckle从WebAPI上的Swagger文档中省略方法
EN

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何使用Swashbuckle从WebAPI上的Swagger文档中省略方法EN