Web API帮助页面未显示XML

时间:2015-05-07 12:46:15

标签: asp.net-mvc-4 asp.net-web-api asp.net-web-api2 asp.net-web-api-helppages

我有一个Web API项目,几个月前我们开始开发时手动删除了 Areas 文件夹。现在一切都完成后,我想添加API帮助页面,但它没有按预期工作。

我为帮助页安装了nuget包。

我在HelpPageConfig.cs

中取消注释了这一行

我检查了生成文档文件(到App_Data文件夹)

当我打开 http://localhost:51665/help 时,我明白了:(没有显示方法)

enter image description here

知道可能出现什么问题吗?如果我从头开始新项目,一切正常。

1 个答案:

答案 0 :(得分:3)

我想您已经分两步设置项目了:

  1. 您应在API项目属性中选择构建标签,并在输出部分设置XML文档文件。例如:App_Data\XmlDocument.xml
  2. 然后,您可以更新方法HelpPageConfig.cs中的Register ...在我的情况下
  3. config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

    • 当您的项目处于编译过程中时,请查看输出窗口,是否真的生成了文档。
    • 尝试使用旧版本的ASP.NET帮助页面(版本5.2.2适用于我)。

      Install-Package Microsoft.AspNet.WebApi.HelpPage -Version 5.2.2