使用控制器上的Xml注释的ASP.NET Web API帮助页面文档

Question

我安装了ASP.NET Web API Help Page软件包，并希望使用它来为我的API控制器操作生成文档，使用它们上面的Xml注释。

我遇到了article on Yao's MSDN blog，他讨论了如何根据XML注释生成文档。

但是，在HelpPageConfig的Register方法中，SetDocumentationProvider方法需要使用到Xml文档文件的物理路径构造的XmlDocumentationProvider实例。

还有其他办法吗？我不清楚为什么我需要指向一个Xml文档文件。

由于

Answer 1

如果您仍有问题，请参阅以下步骤。

第1步 - 在控制器级别添加评论

// GET api/documentation
/// <summary>
/// This is how we create a documentation
/// </summary>
/// <returns></returns>
public IEnumerable<string> Get()

第2步 - 构建属性 “项目属性”页面并设置文档的

第3步 - HelpPage配置

要设置HelpPageConfig以使用我们的文档xml文件，请转到~\Areas\HelpPage\HelpPageConfig.cs。

默认情况下，config.SetDocumentationProvider语句已注释掉。使用该语句，并将DocumentationProvider的位置指向我们的xml文件：

public static void Register(HttpConfiguration config)
{
   // Uncomment the following to use the documentation from XML documentation file.
   config.SetDocumentationProvider(
            new XmlDocumentationProvider(
                HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")));
}

修改

在VS2013中创建的新Web API 2.2项目中HelpPageConfig的位置为~\Areas\HelpPage\App_Start\HelpPageConfig.cs

Answer 2

XmlDocumentationProvider正在查找在编译项目时生成的xml文件（包含xml代码注释）。 您可以通过转到项目属性 - ＆gt;来启用生成此功能。构建 - ＆gt;输出。在这里选择XML文档文件的复选框。

Answer 3

我知道这个问题已得到解答，但万一它可以帮助某人 我找到了这个页面，因为我在寻找IHttpActionResult

文档的解决方案

How to add IHttpActionResult into documentation