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. 然后您可以在方法Register中更新HelpPageConfig.cs...在我的例子中

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

• 当您的项目在编译过程中时，请在输出窗口中查看是否真正生成了文档。

• 尝试使用旧版本的 ASP.NET 帮助页面(5.2.2 版本适合我)。

  安装包 Microsoft.AspNet.WebApi.HelpPage -版本 5.2.2