发布时未更新 Web API 的 XML 帮助文档

Question

根据 online documentation 和 HelpPageConfig.cs 中的注释代码，启用 XML 文档会将 XML 文件添加到 ~App_data/name_of_file.xml。然后将项目构建属性设置为匹配该路径。

但是，在发布时，XML 文件似乎没有发布，这导致访问 api 的帮助页面时出现 YSOD。我已验证文件的构建操作设置为内容。我也尝试过使用“复制到输出目录”，但没有任何效果。

无论如何，为了好奇，我想知道是否有使用他们推荐的文件位置的解决方案，或者它是否只是某种过时的推荐；否则，我想我可以尝试将其移至 bin 目录。

我正在使用 Web API 2.1 帮助页面 nuget 包。

Answer 1

我在尝试发布到 Azure 时遇到了类似的问题。我必须在项目中包含帮助文档 *.xml 文件，然后它们才能发布。

如果您将它们采购到 App_Data 文件夹，请确保在您的发布选项中未选中“从 App_Data 文件夹中排除文件”。

Answer 2

HelpPage 只需要读取文件的有效路径，因此文件来自App_Data 文件夹还是bin 文件夹并不重要。