.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接口文檔如何分組。

 


注意!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系我们删除。



 
粤ICP备14056181号  © 2014-2021 ITdaan.com