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

Question

我安装了 ASP.NET Web API帮助页 包，并想使用它基于已在控制器操作上的Xml注释来生成API文档。

我看到了 Yao 的 MSDN 博客上的一篇文章，其中讨论了如何基于XML注释生成文档。

但是，在 HelpPageConfig 的 Register 方法中，SetDocumentationProvider 方法需要向一个物理路径指向 XML 文档文件构建 XmlDocumentationProvider 实例。是否有其他方法实现此功能？我不清楚为什么需要指向 XML 文档文件。

谢谢！

- George Durzi

Answer 1

如果您仍然遇到问题，请参照以下步骤。

步骤1 - 在控制器级别添加注释

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

第二步 - 构建属性 进入“Project Properties”页面并为文档设置xml输出。

第三步 - 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

- Rikin Patel

---

在使用VS2013创建新的Web API 2.2项目时，HelpPageConfig的位置是~\Areas\HelpPage\App_Start\HelpPageConfig.cs。 - Carl Sharman

@Carl 谢谢你的澄清。 - Si8

Answer 2

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

- Kiran

---

Kiran，谢谢，这个很有用。有没有一种好的方法在运行时以编程方式访问此值？现在我正在使用HttpContext.Current.Server.MapPath... - George Durzi

非常感谢您的回复，我终于弄清楚了如何让它工作。 - Thomas Stock

仍然一样，我仍然看到“无可用文档”。 - Si8

Answer 3

我知道这个问题已经被回答了，但如果有人需要帮助的话，我找到了这个页面，因为在寻找IHttpActionResult文档的解决方案。

如何将IHttpActionResult添加到文档中

- cpoDesign