1

我正在处理一个需要 API 帮助页面上的文档的项目。该页面已创建，可以插入信息。但我有一些问题：

  1. 我对此很陌生，所以我在浏览项目时遇到了一些问题。

  2. 我想引用直接在 Controller 文件中的 XML 注释，如下所示：

    /// <summary>
/// Get all the number of help desk tickets by their current priorities
/// </summary>
/// <returns></returns>


[ActionName("GetCurrentPriority")]
public TicketPriorities GetTicketsByCurrentPriority()
{...

WebApiConfig.cs 文件中的 HTTP 路由代码如下所示：

            config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{action}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

但是，我不知道如何在网络帮助页面上发表评论。我见过很多使用参数 ID 的示例，但似乎没有 ID，而且我不知道如何找到或制作参数 ID，因为帮助页面显示除了 ID 之外的所有内容。例如，我应该创建一个XMLDocument.xml文件并将所有评论都放在那里吗？

4

1 回答 1

3

你有这行代码吗？

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

也不要忘记在项目属性 -> 构建中勾选“XML 文档文件”。将路径设置为App_Data\XmlDocument.xml.

您可能还想禁止警告 CS1591，因为会有很多类（例如在帮助生成代码中），public但不需要添加文档。

有关更多详细信息，请参阅此文档：http ://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages

于 2015-04-14T02:15:09.680 回答