swagger 如何屏蔽默认自带的接口?

发布于 2022-09-07 21:58:20 字数 180 浏览 21 评论 0

如下图,swagger 文档生成后总会默认生成一个 Swagger 接口,配置文件仔细研究了下,也没见屏蔽此接口的选项,

这个接口毫无用处,放这里影响观瞻,请问如何屏蔽这个自身接口?

图片描述

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

注定孤独终老 2022-09-14 21:58:20

1、SwaggerConfig.cs 文件中添加 DocumentFilter

GlobalConfiguration.Configuration.EnableSwagger(c =>{
    // 增加 DocumentFilter
    c.DocumentFilter<HiddenApiFilter>();  
})

2、增加HiddenApiFilter.cs类

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]   
public partial class HiddenApiAttribute : Attribute { }
public class HiddenApiFilter : IDocumentFilter
{
   
    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        foreach (ApiDescription apiDescription in apiExplorer.ApiDescriptions)
        {            
            var _key = "/" + apiDescription.RelativePath.TrimEnd('/');
            // 过滤 swagger 自带的接口
            if (_key.Contains("/api/Swagger") && swaggerDoc.paths.ContainsKey(_key))
                swaggerDoc.paths.Remove(_key);
        }
    }
}

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文