ASP.Net WebApi 2 sample text attribute

Question

Is there a way do provide samples for the web api help pages generation using attributes? I know that I can provide samples by going to /Areas/HelpPage/... but I want them all in one place with my code.

Something along these lines:

    /// <summary>
    /// userPrincipalName attribute of the user in AD
    /// </summary>
    [TextSample("john.smith@contoso.com")]
    public string UserPrincipalName;

score 3 · Accepted Answer · answered Apr 29 '15 at 10:13

This could be achieved by creating a custom attribute yourself, something like:

[AttributeUsage(AttributeTargets.Property)]
public class TextSampleAttribute : Attribute
{
    public string Value { get; set; }

    public TextSampleAttribute(string value)
    {
        Value = value;
    }
}

And then modifying the SetPublicProperties method of ObjectGenerator like this:

private static void SetPublicProperties(Type type, object obj, Dictionary<Type, object> createdObjectReferences)
    {
        PropertyInfo[] properties = type.GetProperties(BindingFlags.Public | BindingFlags.Instance);
        ObjectGenerator objectGenerator = new ObjectGenerator();
        foreach (PropertyInfo property in properties)
        {
            if (property.IsDefined(typeof (TextSampleAttribute), false))
            {
                object propertyValue = property.GetCustomAttribute<TextSampleAttribute>().Value;
                property.SetValue(obj, propertyValue, null);
            }
            else if (property.CanWrite)
            {
                object propertyValue = objectGenerator.GenerateObject(property.PropertyType, createdObjectReferences);
                property.SetValue(obj, propertyValue, null);
            }
        }
    }

I've added a check to see if the TextSampleAttribute is defined and if so use it's value instead of the auto-generated one.

ASP.Net WebApi 2 sample text attribute

1 Answers1