Blame view

netcore/src/Infrastructure/NCC/DynamicApiController/Attributes/ApiDescriptionSettingsAttribute.cs 2.5 KB
de2bd2f9   “wangming”   项目初始化
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
  using NCC.Dependency;
  using NCC.DynamicApiController;
  using System;
  
  namespace Microsoft.AspNetCore.Mvc
  {
      /// <summary>
      /// 接口描述设置
      /// </summary>
      [SuppressSniffer, AttributeUsage(AttributeTargets.Interface | AttributeTargets.Class | AttributeTargets.Method)]
      public sealed class ApiDescriptionSettingsAttribute : ApiExplorerSettingsAttribute
      {
          /// <summary>
          /// 构造函数
          /// </summary>
          public ApiDescriptionSettingsAttribute() : base()
          {
              Order = 0;
          }
  
          /// <summary>
          /// 构造函数
          /// </summary>
          /// <param name="enabled">是否启用</param>
          public ApiDescriptionSettingsAttribute(bool enabled) : base()
          {
              IgnoreApi = !enabled;
              Order = 0;
          }
  
          /// <summary>
          /// 构造函数
          /// </summary>
          /// <param name="groups">分组列表</param>
          public ApiDescriptionSettingsAttribute(params string[] groups) : base()
          {
              GroupName = string.Join(Penetrates.GroupSeparator, groups);
              Groups = groups;
              Order = 0;
          }
  
          /// <summary>
          /// 自定义名称
          /// </summary>
          public string Name { get; set; }
  
          /// <summary>
          /// 保留原有名称(Boolean 类型)
          /// </summary>
          public object KeepName { get; set; }
  
          /// <summary>
          /// 切割骆驼命名(Boolean 类型)
          /// </summary>
          public object SplitCamelCase { get; set; }
  
          /// <summary>
          /// 保留路由谓词(Boolean 类型)
          /// </summary>
          public object KeepVerb { get; set; }
  
          /// <summary>
          /// 小写路由(Boolean 类型)
          /// </summary>
          public object LowercaseRoute { get; set; }
  
          /// <summary>
          /// 模块名
          /// </summary>
          public string Module { get; set; }
  
          /// <summary>
          /// 版本号
          /// </summary>
          public string Version { get; set; }
  
          /// <summary>
          /// 分组
          /// </summary>
          public string[] Groups { get; set; }
  
          /// <summary>
          /// 标签
          /// </summary>
          public string Tag { get; set; }
  
          /// <summary>
          /// 排序
          /// </summary>
          public int Order { get; set; }
  
          /// <summary>
          /// 配置控制器区域(只对控制器有效)
          /// </summary>
          public string Area { get; set; }
      }
  }