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; }
}

哪个会给你这样的输出: -