我的模型的各个属性响应asp.net web api

时间:2014-05-12 17:22:56

标签: asp.net-web-api

我为我的模型的所有属性添加了注释,但它们没有显示在web api 2.0的帮助页面中。有人可以帮我这个吗?

以下是我的应用中的示例模型:

public class ContactDetails
{
    /// <summary>
    /// Gets or sets the telephone.
    /// </summary>
    /// <value>
    /// The telephone.
    /// </value>
    public string telephone { get; set; }
    /// <summary>
    /// Gets or sets the mobile.
    /// </summary>
    /// <value>
    /// The mobile.
    /// </value>
    public string mobile { get; set; }
}

在生成的帮助文件中,电话和移动设备的说明列为空。我该如何为此添加一些描述?

1 个答案:

答案 0 :(得分:0)

您可以按以下方式添加属性的描述和默认值:

[Description("Mobile Number")]
[DefaultValue(typeof(Color), "Red")]
public string mobile { get; set; }

您可以按照以下方式添加文档

   /// <summary>
   /// Name property </summary>
   /// <value>
   /// A value tag is used to describe the property value</value>

添加后重建项目并在xml文档中检查它。如果它在你的xml文档中显示然后在api中显示