27

我安装了ASP.NET Web API 帮助页面包,并希望使用它为我的 API 控制器操作生成文档,并使用它们上已有的 Xml 注释。

在 Yao 的 MSDN 博客上看到了一篇文章,他讨论了如何根据 XML 注释生成文档。

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

还有另一种方法可以做到这一点吗?我不清楚为什么我需要指向一个 Xml 文档文件。

谢谢

4

3 回答 3

44

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

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

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

第 2 步 - 构建属性 项目属性页面并设置文档的 xml 输出

在此处输入图像描述

第 3 步 - 帮助页面配置

要设置 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

于 2015-09-24T06:43:23.710 回答
29

XmlDocumentationProvider 正在寻找在您编译项目时生成的 xml 文件(具有您的 xml 代码注释)。您可以通过转到项目属性 -> 构建 -> 输出来启用生成它。在这里选中 XML 文档文件的复选框。

于 2013-02-12T23:17:32.730 回答
2

我知道这个问题已经得到解答,但如果它对我找到这个页面的人有所帮助,因为我正在寻找 IHttpActionResult 文档的解决方案

如何将 IHttpActionResult 添加到文档中

于 2016-02-23T18:35:35.477 回答