3

将FluentValidation与 WebAPI 结合使用，我试图展示在属性上实现的规则。

我正在使用 Microsoft.AspNet.WebApi.HelpPage 程序集，它将为我的 API 生成帮助页面。我希望能够枚举验证规则，以便可以在帮助页面上显示所需的属性和长度。

以前，我会为自定义属性执行此操作，如下所示：

-- namespace MyAPI.Areas.HelpPage.ModelDescriptions

private readonly IDictionary<Type, Func<object, string>> AnnotationTextGenerator =
    new Dictionary<Type, Func<object, string>>
    {
        { typeof(MyAttribute), a => "My Attribute Documentation" }
    };

这将在帮助页面的附加信息部分添加所需的文本。在使用FluentValidation的情况下，不再设置所需的类型。现在是这样的RuleFor(x => x.MyProperty).NotEmpty();

如果有帮助，记录注释的代码如下：

-- namespace MyAPI.Areas.HelpPage.ModelDescriptions
/// <summary>   Generates the annotations. </summary>
/// <param name="property">         The property. </param>
/// <param name="propertyModel">    The property model. </param>
private void GenerateAnnotations(MemberInfo property, ParameterDescription propertyModel)
{
    var annotations = new List<ParameterAnnotation>();

    var attributes = property.GetCustomAttributes();
    foreach (var attribute in attributes)
    {
        Func<object, string> textGenerator;
        if (AnnotationTextGenerator.TryGetValue(attribute.GetType(), out textGenerator))
        {
            annotations.Add(
                new ParameterAnnotation
                {
                    AnnotationAttribute = attribute,
                    Documentation = textGenerator(attribute)
                });
        }
    }

    // Rearrange the annotations
    annotations.Sort(
        (x, y) =>
        {
            // Special-case RequiredAttribute so that it shows up on top
            if (x.AnnotationAttribute is RequiredAttribute)
            {
                return -1;
            }
            if (y.AnnotationAttribute is RequiredAttribute)
            {
                return 1;
            }

            // Sort the rest based on alphabetic order of the documentation
            return String.Compare(x.Documentation, y.Documentation, StringComparison.OrdinalIgnoreCase);
        });

    foreach (var annotation in annotations)
    {
        propertyModel.Annotations.Add(annotation);
    }
}

在调用此 GenerateAnnotations 例程时，我想添加将查看属性并获取分配的所有流畅属性并添加文本的逻辑。

也许以某种方式使用FluentValidation.Internal.PropertyRules优雅地枚举属性？

4

0 回答 0