Empty модель описание объекта на ASP.NET Web API Помощи Страница

Question

Введения

Я следовал this tutorial для настройки моего ASP.NET Web API Help Pages.

Использование <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 заполнить описание модели собственности на документы. Вместо того, чтобы столбец Описание пуст:

---

Кто-нибудь знает, как решить это?

Answer 1

Можете ли вы использовать Swashbuckle вместо Microsoft.AspNet.WebApi.HelpPage. Я считаю, что Swashbuckle обеспечивает лучшую документацию и дружественный интерфейс для изучения вашего API. Вы также можете использовать его для тестирования вашего API.

Answer 2

Вы раскомментировать эту строку кода в районах/HelpPage/App_Start/HelpPageConfig.cs:

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