-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSwaggerDefaultValueFilter.cs
160 lines (138 loc) · 5.9 KB
/
SwaggerDefaultValueFilter.cs
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
using Microsoft.AspNetCore.Mvc.ApiExplorer;
using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.AspNetCore.Mvc.ModelBinding.Metadata;
using Microsoft.Extensions.Options;
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Models;
using Newtonsoft.Json.Converters;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.ComponentModel;
using System.Linq;
using System.Reflection;
namespace NetPro.Swagger
{
/// <summary>
/// swagger默认值,只对swagger生效,避免直接使用[DefaultValue]影响正常业务
/// </summary>
public class SwaggerDefaultValueFilter : IOperationFilter
{
private readonly dynamic _mvcJsonOptions;
public SwaggerDefaultValueFilter(IOptions<dynamic> mvcJsonOptions)
{
_mvcJsonOptions = mvcJsonOptions.Value;
}
public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
if (operation.Parameters == null || !operation.Parameters.Any())
{
return;
}
var parameterValuePairs = context.ApiDescription.ParameterDescriptions
.Where(parameter => GetDefaultValueAttribute(parameter) != null || (GetParameterInfo(parameter)?.HasDefaultValue ?? false))
.ToDictionary(parameter => parameter.Name, GetDefaultValue);
if (parameterValuePairs.Count == 0) return;
foreach (var parameter in operation.Parameters)
{
if (parameterValuePairs.TryGetValue(parameter.Name, out var defaultValue))
{
parameter.Extensions.Add("default", new OpenApiString(defaultValue?.ToString()));
}
}
}
private SwaggerDefaultValueAttribute GetDefaultValueAttribute(ApiParameterDescription parameter)
{
if (!(parameter.ModelMetadata is DefaultModelMetadata metadata) || metadata.Attributes.PropertyAttributes == null)
{
return null;
}
return metadata.Attributes.PropertyAttributes
.OfType<SwaggerDefaultValueAttribute>()
.FirstOrDefault();
}
public ParameterInfo GetParameterInfo(ApiParameterDescription parameter)
{
if (parameter.ParameterDescriptor != null)
return ((ControllerParameterDescriptor)parameter.ParameterDescriptor).ParameterInfo;
return null;
}
private object GetDefaultValue(ApiParameterDescription parameter)
{
var parameterInfo = GetParameterInfo(parameter);
if (parameterInfo.HasDefaultValue)
{
if (parameter.Type.IsEnum)
{
var stringEnumConverter = _mvcJsonOptions.SerializerSettings.Converters
.OfType<StringEnumConverter>()
.FirstOrDefault();
if (stringEnumConverter != null)
{
if (parameterInfo.DefaultValue != null)
{
var defaultValue = parameterInfo.DefaultValue.ToString();
return stringEnumConverter.CamelCaseText ? ToCamelCase(defaultValue) : defaultValue;
}
}
}
return parameterInfo.DefaultValue;
}
var defaultValueAttribute = GetDefaultValueAttribute(parameter);
return defaultValueAttribute.Value;
}
private string ToCamelCase(string name)
{
return char.ToLowerInvariant(name[0]) + name.Substring(1);
}
}
public class SwaggerJsonDefaultValueFilter : IOperationFilter
{
//private JsonSerializer _jsonSerializer;
public SwaggerJsonDefaultValueFilter(IOptions<dynamic> mvcJsonOptions)
{
//_jsonSerializer = JsonSerializer.CreateDefault(mvcJsonOptions.Value.SerializerSettings);
}
public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
if (operation.Parameters == null) return;
var parameterValuePairs = context.ApiDescription.ParameterDescriptions
.Where(parameter => GetDefaultValueAttribute(parameter) != null || GetParameterInfo(parameter).HasDefaultValue)
.ToDictionary(parameter => parameter.Name, GetDefaultValue);
foreach (var parameter in operation.Parameters)
{
if (parameterValuePairs.TryGetValue(parameter.Name, out var defaultValue))
{
parameter.Required = false;
if (defaultValue != null)
{
//var jValue = (JValue)JValue.FromObject(defaultValue, _jsonSerializer);
//parameter.Extensions.Add("default", jValue.Value);
parameter.Extensions.Add("default", new OpenApiString(defaultValue.ToString()));
}
}
}
}
private DefaultValueAttribute GetDefaultValueAttribute(ApiParameterDescription parameter)
{
return (parameter.ModelMetadata as DefaultModelMetadata)?
.Attributes.PropertyAttributes?
.OfType<DefaultValueAttribute>()
.FirstOrDefault();
}
public ParameterInfo GetParameterInfo(ApiParameterDescription parameter)
{
return ((ControllerParameterDescriptor)parameter.ParameterDescriptor).ParameterInfo;
}
private object GetDefaultValue(ApiParameterDescription parameter)
{
var parameterInfo = GetParameterInfo(parameter);
if (parameterInfo.HasDefaultValue)
{
return parameterInfo.DefaultValue;
}
else
{
return GetDefaultValueAttribute(parameter)?.Value;
}
}
}
}