Question

我无法弄清楚如何在我的Web Api中获取帮助页面以显示除无之外的资源描述。它有IHttpActionResult链接，然后＆＃34;无。＆＃34;之后。我通过将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

（这可能应该是一个评论，但我还没有足够的代表）

我从break指向Areas \ HelpPage中的各个点开始 - 例如XmlDocumentationProvider - 看看是否能提供任何线索。什么都没有飞跃我。

您是否已更改XML帮助文件的输出位置并且未更新传递给XmlDocumentationProvider的文档路径？该路径通过“属性”页面 - “输出XML文档文件”进行设置。

Web API帮助页面上的资源描述显示＆＃34;无。＆＃34;

2 个答案: