Страница справки Microsoft Web API - как создавать аннотации для параметров

Question

Недавно я начал играть с новой функциональностью страницы справки web api, которая недавно была добавлена ​​в шаблон проекта web api. И у меня есть уведомление, что некоторые столбцы "Дополнительная информация" всегда "нет".

Посмотрев на разметку, я обнаружил, что эта информация должна поступать из атрибутов

 <td class="parameter-annotations">
                    @if (parameter.Annotations.Count > 0)
                    {
                        foreach (var annotation in parameter.Annotations)
                        {
                            <p>@annotation.Documentation</p>
                        }
                    }
                    else
                    {
                        <p>None.</p>
                    }
                </td>

Но какой атрибут я должен использовать, чтобы заполнить дополнительную информацию? Спасибо

Answer 1

Смотрите этот сайт для примера того, как добавить дополнительную информацию.

Это в основном аннотирует вашу модель, поэтому в вашем случае это будет что-то вроде:

public class Product
{
    /// <summary>
    ///  The id of the product
    /// </summary>
    [Required]
    public int Id { get; set; }

    /// <summary>
    /// The name of the product
    /// </summary>
    [MaxLength(50)]
    public string Name { get; set; }
}

Что даст вам вывод, как это:-