我将Swagger / Swashbuckle集成到了.NET Core 2.2 API项目中。一切都很好,我要问的纯粹是为了方便。考虑以下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的默认值?这个answer建议放置[DefaultValue(“ value here”))属性的SomeRequest
类的每个属性。它可能适用于常规.NET,但不适用于.NET Core。
是否可以为Swagger UI提供参数的默认值?
答案 0 :(得分:3)
要为.NET Core中的Swagger UI定义参数的默认值,以下article为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选项(在Startup.cs中):
services.AddSwaggerGen(c => {
// ...
c.SchemaFilter<SchemaFilter>();
});
答案 1 :(得分:1)
最初的功劳归功于Rahul Sharma,尽管如果有人对.NET Core 3.0+感兴趣,Swashbuckle 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;
}
}
}
}
答案 2 :(得分:1)
Swashbuckle.AspNetCore 5.6.3仅需要DefaultValueAttribute
。