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

有关如何添加附加信息的示例，请参见this site。

它基本上标注模型，所以在你的情况下，它会是这样的： -

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

这将使你像这样的输出： -