WebApi帮助页面描述

在辅助页面和引言段落上填充Webapi方法的描述是什么？

Answer 1

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

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

现在启用XML文档。 在解决scheme资源pipe理器中，右键单击该项目并select属性。 select生成页面。

在输出下，检查XML文档文件。 在编辑框中，input“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类（Areas / HelpPage / App_Start / HelpPageConfig.cs）的Register方法中，取消注释第19行，不要忘记更改文件path，如下所示：

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

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