Swagger 過濾特定控制器配置方法(Swashbuckle.AspNetCore 5.0.0)


//首先startup注入
     services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo() { Title = "App", Version = "v1" });
                var xmlFile = $"App.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath);
                c.DocumentFilter<HiddenApiFilter>();//過濾的核心filter
                foreach (var name in Directory.GetFiles(AppContext.BaseDirectory, "*.xml",
                  SearchOption.AllDirectories))
                {
                    c.IncludeXmlComments(name);
                }
            });
    /// <summary>
    /// 隱藏接口,不生成到swagger文檔展示(Swashbuckle.AspNetCore 5.0.0)
    /// </summary>
    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
    public partial class HiddenApiAttribute : Attribute { }
    public class HiddenApiFilter : IDocumentFilter
    {
        /// <summary>
        /// 重寫Apply方法,移除隱藏接口的生成
        /// </summary>
        /// <param name="swaggerDoc">swagger文檔文件</param>
        /// <param name="context"></param>
        public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
        {
            foreach (ApiDescription apiDescription in context.ApiDescriptions)
            {
                var api = apiDescription.ActionDescriptor as Microsoft.AspNetCore.Mvc.Controllers.ControllerActionDescriptor; //這里強轉來獲取到控制器的名稱
                var contoller = api.ControllerName;
                if (api.ControllerName== "CommonBase")//過濾的核心邏輯
                {
                    string key = "/" + apiDescription.RelativePath;
                    if (key.Contains("?"))
                    {
                        int idx = key.IndexOf("?", StringComparison.Ordinal);
                        key = key.Substring(0, idx);
                    }
                    swaggerDoc.Paths.Remove(key);
                }
              
            }
        }

    }

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM