zoukankan      html  css  js  c++  java
  • 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);
                    }
                  
                }
            }
    
        }
     
  • 相关阅读:
    MIB Browser使用方法
    RestTemplate调用https接口跳过证书验证
    Looper&Handler
    Thread类以及常见得同步类
    Android 关键类(RefBase,sp, wp)
    JNI
    binder
    struct enum union区别
    Q_PROPERTY
    linux 命令
  • 原文地址:https://www.cnblogs.com/chongyao/p/12484773.html
Copyright © 2011-2022 走看看