带有Swagger和FluentValidation的Web API 2文档

Question

我们正在使用Web API 2和流畅的验证功能来开发Web API。 一切正常。

但是，我们意识到我们在流利验证中定义的规则并没有得到大张旗鼓（Swashbuckle）的尊重。

例如

Class Customer {
    public string Name {get;set;}
}

如果我在流利的验证器中将名称定义为必填字段，则该属性在api中被标记为可选。 我知道我们可以通过使用.net批注属性来实现该功能。 但是我们不想分离验证逻辑（某些逻辑在.net批注中不容易实现。

任何意见，将不胜感激。

Answer 1

通过将自定义SchemaFilter添加到Swagger配置中，可以将Fluent Validation规则包括到Swagger文档中。

将以下代码添加到SwaggerConfig.cs文件：

c.SchemaFilter<FluentValidationRules>();

并使用以下代码继承ISchemaFilter ：

public class FluentValidationRules : ISchemaFilter
{
    public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type)
    {
        var validator = new Customer(); //Your fluent validator class

        schema.required = new List<string>();

        var validatorDescriptor = validator.CreateDescriptor();

        foreach (var key in schema.properties.Keys)
        {
            foreach (var validatorType in validatorDescriptor.GetValidatorsForMember(key))
            {
                if (validatorType is NotEmptyValidator)
                {
                    schema.required.Add(key);
                }
            }
        }
    }
}

Answer 2

查看来自 Github上SwashBluckle的信息 ，似乎您不能对其使用Fluent Validation。