在swagger显示的api文档中，隐藏指定的api
实现过滤类
Asp.Net版本
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
public class SwaggerDocumentFilter : Swashbuckle.Swagger.IDocumentFilter
{
public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
{
// 骚操作之隐藏abp动态生成的api
var apis = apiExplorer.ApiDescriptions.Where(x => x.RelativePath=="xxx");
if (apis.Any())
{
foreach (var item in apis)
{
swaggerDoc.paths.Remove("/" + item.RelativePath);
}
}
}
}
Asp.Net Core版本
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
public class SwaggerDocumentFilter : IDocumentFilter
{
public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
{
var apis = context.ApiDescriptions.Where(x => x.RelativePath=="xxx");
if (apis.Any())
{
foreach (var item in apis)
{
swaggerDoc.Paths.Remove("/" + item.RelativePath);
}
}
}
}
引用过滤器
Asp.Net版本
1
2
3
4
5
6
7
8
GlobalConfiguration.Configuration
.EnableSwagger(c =>
{
c.DocumentFilter<SwaggerDocumentFilter>();
})
.EnableSwaggerUi(c =>
{
});
Asp.Net Core版本
1
2
3
4
5
6
services.AddSwaggerGen(options =>
{
// 应用Controller的API文档描述信息
options.DocumentFilter<SwaggerDocumentFilter>();
});
本文会经常更新，请阅读原文： https://dashenxian.github.io/post/Swagger%E8%BF%87%E6%BB%A4%E6%8C%87%E5%AE%9A%E7%9A%84api%E6%98%BE%E7%A4%BA ，以避免陈旧错误知识的误导，同时有更好的阅读体验。
本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布，但务必保留文章署名 小神仙 （包含链接： https://dashenxian.github.io ），不得用于商业目的，基于本文修改后的作品务必以相同的许可发布。如有任何疑问，请 与我联系 (125880321@qq.com) 。