.Net core 下Swagger如何隐藏接口的显示

    Swagger是这个非常强大的api文档工具，通常可以用来测试接口，和查看接口，就像这样：

非常的好用和快捷，这是一个小小的demo，我们在完成系统时，发布后，外部依旧可以用/swagger访问到这个接口文档，这就造成了系统不安全的问题，那么我们应该怎么办呢，我们需要隐藏这些接口。

如何隐藏呢，首先我们需要建立一个新类：

namespace TR.Unit
{
    using System;
    using System.Linq;
    using Microsoft.AspNetCore.Mvc.ApiExplorer;
    using Swashbuckle.AspNetCore.Swagger;
    using Swashbuckle.AspNetCore.SwaggerGen;

    /// <summary>
    /// 隐藏接口，不生成到swagger文档展示
    /// </summary>
    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)] //此特性可以在方法上和类上使用

    public partial class HiddenAttribute : Attribute
    {
    }

    public class HiddenFilter : IDocumentFilter
    {
        public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
        {
            foreach (ApiDescription apiDescription in context.ApiDescriptionsGroups.Items.SelectMany(e => e.Items))
            {
                if (apiDescription.ControllerAttributes().OfType<HiddenAttribute>().Count() == 0
                    && apiDescription.ActionAttributes().OfType<HiddenAttribute>().Count() == 0)
                {
                    continue;
                }

                var key = "/" + apiDescription.RelativePath.TrimEnd('/');
                if (!key.Contains("/test/") && swaggerDoc.Paths.ContainsKey(key))
                {
                    swaggerDoc.Paths.Remove(key);
                }
            }
        }
    }
}

首先我们需要引入 using Swashbuckle.AspNetCore.Swagger; using Swashbuckle.AspNetCore.SwaggerGen;

这两个命名空间，其次我们需要继承Attribute 类，方便我们在需要隐藏的接口中使用隐藏特性，这里命名可以随意，不过还是直观一点。

然后就需要在你想要隐藏的控制器上加上 [Hidden]就可以啦，就像这样

    [Hidden]
    [Route("Home")]
    [Authorize]
    public class HomeController : Controller
    {
        /// <summary>
        /// 主界面
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public IActionResult Home()
        {
            return View();
        }
    }

这里是隐藏控制器下所有的接口，也可以方法上隐藏，从而暴露一些接口。

这就是隐藏Swagger接口的显示了，下次写Swagger接口文档如何分组。

 

转载于:https://www.cnblogs.com/Ivan-Wu/p/10648599.html