2014-01-07 15 views
8

У меня есть простой проект webapi2.Включение документации на странице справки WebApi2

Единственная информация, которую я могу найти себе относится к старшему webapi1

Из моего контроллера, если у меня есть

/// <summary> 
    /// Gets a list of not very interesting information 
    /// </summary> 
    /// <returns>The list</returns> 
    [ResponseType(typeof(ExampleModel))] 
    public IHttpActionResult Get() 
    { 
     var data = new List<ExampleModel>() 
     { 
      new ExampleModel() 
      { 
       Date = DateTime.Now, 
       Name = "Tom" 
      }, 
      new ExampleModel() 
      { 
       Date = DateTime.Now.AddDays(-20), 
       Name = "Bob" 
      } 
     }; 

почему нет информации появляется при попытке перейти к странице помощи. Мне сообщили, что документации нет.

Есть ли какой-нибудь волшебный переключатель, который включит автоматическую популяцию этих данных?

+0

Возможный дубликат [ASP.NET Web API Справочная страница страницы с помощью комментариев Xml на контроллерах] (http://stackoverflow.com/questions/14843243/asp-net-web-api-help-page-documentation-using-xml-comments-on-controllers) –

ответ

10

, если вы имеете в виду отображения комментариев XML, то вы можете найти свой ответ здесь:

ASP.NET Web API Help Page documentation using Xml comments on controllers

Обязательно раскомментировать этот код в районах/HelpPage/App_Start/HelpPageConfig.cs

// Uncomment the following to use the documentation from XML documentation file. 
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml"))); 

Также убедитесь, что файл xml находится в App_Data, а не в бине, где он по умолчанию имеет свойства проекта

+0

Я пробовал что без какой-либо удачи, однако, исходя из даты публикации, не уверен, что ее все еще актуально для webapi2 –

+8

, что на самом деле все еще актуально для Web API 2. BTW, вы раскомментировали строку кода в «HelpPageConfig.cs», чтобы включить документацию из XML-файла? –

+0

Да, жаль, что вы были правы. Спасибо. –