Asp.net mvc WebApi帮助页说明

是什么填充了helper页面和简介段落中的

Webapi

方法描述

---

要查看说明，您需要遵循以下步骤：

客户控制器中的每个操作都必须有XML文档

打开包含控制器的项目的属性并启用XML文档，如下所示：

在HelpPageConfig类（Areas/HelpPage/App_Start/HelpPageConfig.cs）的Register方法中，取消对第19行的注释，不要忘记如下更改文件路径：

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

这就是你必须做的一切。

---

最后一件事是将在App_数据中创建的文件包含在项目中，以便在生产中部署该文件。

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

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

现在启用XML文档。在解决方案资源管理器中，在项目上单击鼠标右键，然后选择“属性”。选择构建页面

在“输出”下，检查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";
}

//
///从服务器获取一些非常重要的数据。
/// 
公共IEnumerable Get（）
{
返回新字符串[]{“value1”，“value2”}；
}
/// 
///按ID查找某些数据。
/// 
///数据的ID。
公共字符串Get（int-id）
{
返回“值”；
}

对于那些使用VB.NET的人来说，你似乎不得不做一些不同的事情

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

输出实际上被放入/bin/{projectName}.xml，因此现在您必须更改

SetDocumentationProvider

调用以指向路径“~/bin/{projectName}.xml”（显然，用实际的项目名称替换{projectName}）

---

这似乎很臭，所以如果有人找到不同的方法，请告诉我。

对我来说（VS2013），还有更多的事情要做。1.）输出下文档文件的路径必须使用反斜杠，而不是普通斜杠。2.）在解决方案资源管理器中，我必须将XmlDocument.xml添加到项目中（首先切换“全部查看”按钮），并将文件的“复制到输出目录”属性设置为“更新时复制”（请参见CodeNotFounds答案）。如果要从帮助文档中省略ApiController，则有此开箱即用属性-[ApiExplorerSettings（IgnoreApi=true）]。请注意，每次重建解决方案时，XML文件都会自动生成/更新。nznoor示例中显示的注释将自动拾取作为文档注释，并用作说明