asp.net-mvc-4 - Web API 帮助页面未显示 XML

Question

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

我为帮助页面安装了 nuget 包。

我取消注释行HelpPageConfig.cs

我检查了生成文档文件（到 App_Data 文件夹）

当我打开http://localhost:51665/help我得到这个：（没有显示方法）

知道有什么问题吗？如果我从头开始新项目，一切正常。

Answer 1

我想你已经分两步设置了你的项目：

1. 您应该在 API 项目属性中选择构建选项卡并在输出部分设置 XML 文档文件。例如：App_Data\XmlDocument.xml
2. 然后你可以更新HelpPageConfig.cs方法Register......在我的情况下

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