Web API帮助页面未显示XML

Question

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

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

我没有注释 HelpPageConfig.cs

我检查了Generate文档文件(到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