WebApi帮助页面描述

Question

在帮助页面和介绍段落中填充Webapi方法说明的内容是什么？

Answer 1

根据此 article ，您可以使用XML文档注释来创建文档。要启用此功能，请打开文件Areas / HelpPage / App_Start / HelpPageConfig.cs并取消注释以下行：

config.SetDocumentationProvider(new XmlDocumentationProvider(
    HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

现在启用XML文档。在解决方案资源管理器中，右键单击项目并选择“属性”。选择Build页面。

在“输出”下，检查XML文档文件。在编辑框中，键入“App_Data / XmlDocument.xml”。

向控制器方法添加一些文档注释。例如：

/// <summary>
/// Gets some very important data from the server.
/// </summary>
public IEnumerable<string> Get()
{
    return new string[] { "value1", "value2" };
}

/// <summary>
/// Looks up some data by ID.
/// </summary>
/// <param name="id">The ID of the data.</param>
public string Get(int id)
{
    return "value";
}

Answer 2

要查看说明，您需要按照以下步骤操作：

1. 客户控制器中的每项操作都必须包含 XML文档
2. 打开包含控制器的项目的属性，并启用如下所示的XML文档：
3. 在 HelpPageConfig 类的注册方法中（区域/ HelpPage / App_Start / HelpPageConfig.cs）取消注释第19行，不要忘记更改文件路径是这样的：

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/MvcApplication4.XML")));

这一切你必须做的。 最后一件事是在项目中包含在App_Data中创建的文件，以便将文件部署到生产中。

Answer 3

对于使用VB.NET的用户来说，您似乎必须做些不同。

您必须转到Web API项目的“ 编译”选项卡（没有“构建”选项卡），然后确保已选中“ 生成XML文档文件”复选框。已选中。

输出实际上被放入 / bin / {projectName} .xml 中，因此现在您必须更改SetDocumentationProvider调用以指向路径“ 〜/ bin /{projectname}.xml”（显然，将{projectname}替换为您的实际项目名称）。

这听起来很臭，所以请让我知道是否有人找到其他方法来做

。