我已经将Swagger/Swashuckle集成到一个.NETCore 2.2API项目中。一切都很好，我所要求的纯粹是为了方便。考虑以下API方法：
public Model SomeEstimate(SomeRequest request) {
return Manager.GetSomeEstimate(request);
}
...
public class SomeRequest {
public string StreetAddress { get; set; }
public string Zip { get; set; }
}
当我 /swagger/index.html并想尝试这个API时，我总是必须输入StreetAddress和Zip值。
有没有办法为StreetAddress和Zip提供默认值？这个答案建议将[DefaultValue（"value this"）]属性放置在有请求类的每个属性中。它可能适用于常规的。NET，但不适用于。NET核心。
是否可以为SwaggerUI的参数提供默认值？
要在.NETCore中为SwaggerUI定义参数的默认值，以下文章为Model类中的DefaultValue属性定义了自定义模式过滤器。下面显示的代码取自本文，纯粹是为了通知任何有此问题或面临类似问题的人：
在模型中装饰所需的属性：
public class Test {
[DefaultValue("Hello")]
public string Text { get; set; }
}
主过滤器：
using System.Collections.Generic;
using System.ComponentModel;
using System.Reflection;
using Swashbuckle.AspNetCore.Swagger;
using Swashbuckle.AspNetCore.SwaggerGen;
namespace Project.Swashbuckle {
public class SchemaFilter : ISchemaFilter {
public void Apply(Schema schema, SchemaFilterContext context) {
if (schema.Properties == null) {
return;
}
foreach (PropertyInfo propertyInfo in context.SystemType.GetProperties()) {
// Look for class attributes that have been decorated with "[DefaultAttribute(...)]".
DefaultValueAttribute defaultAttribute = propertyInfo
.GetCustomAttribute<DefaultValueAttribute>();
if (defaultAttribute != null) {
foreach (KeyValuePair<string, Schema> property in schema.Properties) {
// Only assign default value to the proper element.
if (ToCamelCase(propertyInfo.Name) == property.Key) {
property.Value.Example = defaultAttribute.Value;
break;
}
}
}
}
}
private string ToCamelCase(string name) {
return char.ToLowerInvariant(name[0]) + name.Substring(1);
}
}
}
最后将其注册到您的Swagger Options（在Startup. cs中）：
services.AddSwaggerGen(c => {
// ...
c.SchemaFilter<SchemaFilter>();
});
最初的功劳归于Rahul Sharma，尽管如果有人感兴趣的话。NETCore 3.0，Swashuckle v5.0.0-rc4使SchemaFilter定义变得更加简单。也许有一种方法可以用新属性或类似的东西添加示例值，但我还没有找到这样的方法。
public class SchemaFilter : ISchemaFilter
{
public void Apply(OpenApiSchema schema, SchemaFilterContext context)
{
if (schema.Properties == null)
{
return;
}
foreach (var property in schema.Properties)
{
if (property.Value.Default != null && property.Value.Example == null)
{
property.Value.Example = property.Value.Default;
}
}
}
}
Swashuckle. AspNetCore 5.6.3只需要DefaultValueAt和。
