Question

我有一个post动作，接收Person类型的FromBody参数。在HelpPage中，我获得有关Person paramater的信息。是否可以在Person中列出有关属性的信息，并使用XML文档文件中的文档来获取每个属性的描述？

public class PersonController : ApiController
{
    /// <summary>
    /// Add a person
    /// </summary>
    /// <param name="person">Person to add</param>
    /// <returns></returns>
    [HttpPost]
    public HttpResponseMessage Add([FromBody] Person person)
    {
        // ...

        return Request.CreateResponse(HttpStatusCode.Created);
    }
}

/// <summary>
/// A person
/// </summary>
public class Person
{
    /// <summary>
    /// The name of the person
    /// </summary>
    public String Name { get; set; }

    /// <summary>
    /// The age of the person
    /// </summary>
    public Int32 Age { get; set; }
}

Answer 1

目前不支持开箱即用。有一个相关的工作项，要求为模型上使用的数据注释属性生成帮助页面。您的方案应该在其固定的http://aspnetwebstack.codeplex.com/workitem/877

之后工作

ASP.Net Web API帮助页面：记录复杂类型属性

1 个答案: