向Swagger文档添加自定义ValidationAttribute

Question

我有一个自定义验证属性

假设我有一个实现ValidationAttory的HelloWorld类。然后我将此属性应用于我的API中的一个字段。

[HelloWorld]
public string FirstName { get; set; }

当我生成Swagger UI时，我得到一个JSON OpenAPI规范，模型显示每个字段的属性，如下所示：

如果我添加了一个必需的标记，如果我使用诸如RegularExpression/Range/StringLength之类的属性，则会显示一个星号，文本会指定这一点。然而，我想用我自己的描述让别人知道自定义验证。

有可能吗？

任何帮助都将不胜感激。我花了一整天的时间研究DocumentFilter/SchemaFilter/OperationFilter，但找不到任何好的文档或示例。

Answer 1

你可以这样做：

>

创建自定义验证属性，例如UniqueAttribute

public class UniqueAttribute : ValidationAttribute { ... }

将此属性应用于模型特性

[Unique]
public string Name { get; set; }

实现ISchemaFilter接口扩展

public class AddUniquenessDescriptionFilter : ISchemaFilter
{
  public void Apply(OpenApiSchema schema, SchemaFilterContext context)
  {
    var attr = context.MemberInfo?.CustomAttributes.Where(x => 
         x.AttributeType.Name == nameof(UniqueAttribute)) 
         .FirstOrDefault();

    if (attr is not null)
    {
      schema.Extensions.Add("isUnique", new OpenApiBoolean(true));
    }
  }
}

并在启动时使用扩展

builder.Services.AddSwaggerGen(options => 
{ 
  options.SchemaFilter<AddUniquenessDescriptionFilter>(); 
});

结果如下：招摇文档

下面是一个完整的示例：自定义ValidationAttribute

Answer 2

我试图使用OperationFilter，但上不支持它。Net Framework 4.1。

我必须使用过滤器来修改文档（我相信这是使用was x扩展）