ASP.NET Web API帮助页面

Question

简介

我已按照this tutorial设置我的ASP.NET Web API帮助页面。

使用<package id="Microsoft.AspNet.WebApi.HelpPage" version="5.2.3" targetFramework="net452" />

文档似乎很好，但我得到空模型属性描述。

它们在控制器方法/端点和模型详细信息doc中都是空的。

控制器方法示例

/// <summary>
/// POST: api/remitent
/// </summary>
/// <param name="remitent"></param>
public void Post([FromBody]Remitent remitent)
{

}

模型属性示例

/// <summary>
/// First name property summary
/// </summary>
[Required]
[MaxLength(49)]     
public string FirstName { get; set; }

结果

我希望FirstName属性摘要填充docs上的模型属性描述。相反，描述列为空：

有谁知道如何解决这个问题？

Answer 1

您是否在Regions / HelpPage / App_Start / HelpPageConfig.cs中取消注释这行代码：

config.SetDocumentationProvider(new XmlDocumentationProvider(
    HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

Answer 2

您可以使用Swashbuckle而不是Microsoft.AspNet.WebApi.HelpPage。我发现Swashbuckle提供了更好的文档和友好的用户界面来探索您的API。您也可以使用它来测试您的API。