Swagger 增加 DocumentFilter 隐藏不需要显示的接口

services.ConfigureSwaggerGen(options => {
    options.SingleApiVersion(new Info {
        Version = "v1",
        Title = "xxx API",
        Description = "xxx 项目webapi接口说明",
        TermsOfService = "None",
        Contact = new Contact { Name = "xxx", Email = "", Url = "http://xxx.com" },
        License = new License { Name = "xxx", Url = "http://xxx.com" }
    });
    options.IncludeXmlComments(AppContext.BaseDirectory + @"/Admin.xml"); // 这个需要开启项目生成 xml 选项
    options.DocumentFilter<HiddenApiFilter>();
    // 在接口类、方法标记属性 [HiddenApi]，可以阻止【Swagger文档】生成
});

1	`HiddenApiFilter.cs 代码实现部分<br><br>`

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public partial class HiddenApiAttribute : Attribute { }
public class HiddenApiFilter : IDocumentFilter {
    public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context) {
        foreach (ApiDescription apiDescription in context.ApiDescriptionsGroups.Items.SelectMany(e => e.Items)) {
            if (apiDescription.GetControllerAttributes().OfType<HiddenApiAttribute>().Count() == 0 
                && apiDescription.GetActionAttributes().OfType<HiddenApiAttribute>().Count() == 0) continue;
 
            var key = "/" + apiDescription.RelativePath.TrimEnd('/');
            if (!key.Contains("/test/") && swaggerDoc.Paths.ContainsKey(key))
                swaggerDoc.Paths.Remove(key);
        }
    }
}

__EOF__

本文作者：FreeSql & CSRedis
本文链接：https://www.cnblogs.com/kellynic/p/6092879.html
关于博主：评论和私信会在第一时间回复。或者直接私信我。
版权声明：本博客所有文章除特别声明外，均采用 BY-NC-SA 许可协议。转载请注明出处！
声援博主：如果您觉得文章对您有帮助，可以点击文章右下角【推荐】一下。您的鼓励是博主的最大动力！