WebApi Swagger隐藏接口

1、Nuget安装Swashbuckle.AspNetCore

2、新建HiddenApiFilter类，

1.  
   /// <summary>
2.  
   /// 隐藏不需要显示的接口
3.  
   /// </summary>
4.  
   [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
5.  
   public partial class HiddenApiAttribute : Attribute { }
6.  
   public class HiddenApiFilter : IDocumentFilter
7.  
   {
8.  
   public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
9.  
   {
10.  
    foreach (ApiDescription apiDescription in context.ApiDescriptions)
11.  
    {
12.  
    var api = apiDescription.ActionDescriptor as Microsoft.AspNetCore.Mvc.Controllers.ControllerActionDescriptor;
13.  
    var contoller = api.ControllerName;
14.  
    List<string> list = new List<string>();
15.  
    //添加需要隐藏控制器
16.  
    list.Add("Access");
17.  
    list.Add("admin");
18.  
    list.Add("AirConditioner");
19.  
    list.Add("Alarm");
20.  
    list.Add("ArchiverDetails");
21.  
    list.Add("ArchivesBox");
22.  
    list.Add("ArchivesTypeClass");
23.  
    list.Add("Area");
24.  
    list.Add("Audit");
25.  
    list.Add("DenseFrameTask");
26.  
    list.Add("device");
27.  
    list.Add("EnvironmentalEquipment");
28.  
    list.Add("Equipment");
29.  
    list.Add("Gygzz");
30.  
    list.Add("device");
31.  
    list.Add("iclock");
32.  
    list.Add("Irealer");
33.  
    list.Add("Login");
34.  
    list.Add("MaintenanceInstructions");
35.  
    list.Add("MonitoringSystemSettings");
36.  
    list.Add("PDA");
37.  
    list.Add("Permission");
38.  
    list.Add("ReportStatisticsService");
39.  
    list.Add("RFIDInventory");
40.  
    list.Add("RFIDTask");
41.  
    list.Add("Role");
42.  
    list.Add("ScanCode");
43.  
    list.Add("SystemSettings");
44.  
    list.Add("task");
45.  
    list.Add("ThreeDimensional");
46.  
    list.Add("Threshold");
47.  
    list.Add("tools");
48.  
    list.Add("User");
49.  
    list.Add("Video");
50.  
    list.Add("WareHouse");
51.  
    list.Add("Archives");
52.  
     
53.  
    if (list.Contains(api.ControllerName))//过滤的核心逻辑
54.  
    {
55.  
    string key = "/" apiDescription.RelativePath;
56.  
    if (key.Contains("?"))
57.  
    {
58.  
    int idx = key.IndexOf("?", StringComparison.Ordinal);
59.  
    key = key.Substring(0, idx);
60.  
    }
61.  
    swaggerDoc.Paths.Remove(key);
62.  
    }
63.  
     
64.  
    }
65.  
    }
66.  
    }

3、在Startup.cs类中的AddSwaggerGen方法中添加  c.DocumentFilter<HiddenApiFilter>();

 c.DocumentFilter<HiddenApiFilter>();

这篇好文章是转载于：学新通技术网