Описание ресурса на странице справки веб-API показывает «Нет».

Question

У меня возникли проблемы с выяснением того, как получить страницу справки в моем веб-Api, чтобы показать что-либо для описания ресурсов, отличного от None. Он связан с IHttpActionResult, а затем «Нет». после этого. Я получил свои образцы, добавив config.SetActualResponseType(typeof(ComplexType), "Controller", "Action"); в HelpPageConfig.cs. Мой контроллер выглядит следующим образом:

/// <summary> 
/// My description 
/// </summary> 
[Route("MyRoute")] 
public IHttpActionResult Get() 
{ 
    try 
    { 
     //throw new Exception("TEST"); 
     return Ok(returnValue); 
    } 
    catch (Exception ex) 
    { 
     *Company Log Method* 
     return NotFound(); 
    } 
} 

Я не знаю, что я пропускаю из HelpPageConfig.cs или любого другого места. Может быть, свежий набор глаз может что-то поймать. Заранее спасибо за помощь!

Answer 1

Мне просто нужно было добавить [ResponseType(typeof(MyModel))] над моим действием после включения using System.Web.Http.Description; в верхней части моего контроллера. Теперь я получаю описание своей модели вместо IHttpActionResult и «None».

Answer 2

(Это, вероятно, должно быть комментарий, но я не хватает респ еще)

Я хотел бы начать с перерыва, указывая различные точки в районах \ HelpPage - например XmlDocumentationProvider - чтобы узнать, дает ли это какие-либо подсказки. На меня ничего не выскочит.

Может быть, вы изменили, откуда вышла XML-файл справки, а не обновили путь к документу, переданный XmlDocumentationProvider? Путь устанавливается через страницу «Свойства» - «Выходной файл документации XML».