.net WebApi的Swagger中隱藏接口

在我們佈置生產環境的時候往往只希望可以只調用接口而不希望可以看到幫助文檔，這是我們就需要將接口隱藏起來。

一、在SwaggerConfig.cs中加入

        /// <summary>  
        /// 隱藏接口，不生成到swagger文檔展示  
        /// </summary>  
        [System.AttributeUsage(System.AttributeTargets.Method | System.AttributeTargets.Class)]

        public partial class HiddenApiAttribute : System.Attribute { }
        public class HiddenApiFilter : IDocumentFilter
        {
            /// <summary>  
            /// 重寫Apply方法，移除隱藏接口的生成  
            /// </summary>  
            /// <param name="swaggerDoc">swagger文檔文件</param>  
            /// <param name="schemaRegistry"></param>  
            /// <param name="apiExplorer">api接口集合</param>  
            public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
            {
                foreach (ApiDescription apiDescription in apiExplorer.ApiDescriptions)
                {
                    if (Enumerable.OfType<HiddenApiAttribute>(apiDescription.GetControllerAndActionAttributes<HiddenApiAttribute>()).Any())
                    {
                        string key = "/" + apiDescription.RelativePath;
                        if (key.Contains("?"))
                        {
                            int idx = key.IndexOf("?", System.StringComparison.Ordinal);
                            key = key.Substring(0, idx);
                        }
                        swaggerDoc.paths.Remove(key);
                    }
                }
            }
        }

如圖所示

並且在SwaggerConfig.cs中加入

c.DocumentFilter<HiddenApiFilter>();

如圖所示

API隱藏實例

將需要隱藏的接口的前面加上[HiddenApi]即可隱藏該接口的文檔生成