.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]即可隐藏该接口的文档生成