在一个有大量资源的 api 的大系统中，我希望以某种配置的方式拆分文档。

就像他们是不同的api一样。

因此，在 web api 的主页中，我有一个配置的“资源”列表。

比方说：管理联系人[这里我想公开'联系人'资源、'地址'资源等。管理订单[产品资源、订单资源、交付资源、余额资源等] 管理产品[产品资源、类别资源， ETC]

因此，api使用者更容易根据任务来理解应该注意哪些方法。

此外，如您所见，不同的部分使用相同的资源，这意味着如果我更改 Product 资源上的某些内容，两个文档都应该（理想情况下）自动更新，包括版本信息等。

编辑：

这是我对 helpcontroller 的索引操作，不确定您的意思。

我有一个需要为其生成文档的 API。我已使用以下文章在我的 API 上设置文档，并且运行良好。

我正在使用：Microsoft.AspNet.WebApi.HelpPageNuGet 包为我的 WebApi 生成文档，并且我一直在关注本教程。

http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages

一切运行良好，我的 Api Endpoints 有一些出色的文档。可悲的是，它返回的数据对象没有相关的文档，我对如何做到这一点有点茫然。过去我使用过 Sandcastle 等，它结合了文档文件。

因此，目前据记录，我已取消注释该行：

这允许生成 api 程序集的文档，但我找不到引用其他程序集的方法。

我的 Web api 项目中有不同的插件和他们自己的 XML 文档，并且有一个集中的帮助页面，但问题是 Web Api 的默认帮助页面只支持单个文档文件

如何从不同的文件加载配置？我想做这样的事情：

The ASP.NET Web API Help Page project does not produce complete documentation for F# record types used as parameters or result types for Web API controller actions. Members are listed, but summary information in XML comments is not displayed in the generated documentation. How do I fix this?

Example

Consider the following F# record type being used as a parameter or result type for a Web API action method:

Expected output

The generated help page documentation for this type should include the summary information in description column for this member.

Actual output

What we actually see is that the summary information is completely absent.

Specifics

This issue occurs in relation to the following specific technologies:

• Microsoft ASP.NET Web API Help Pages v5.1.1;
• Visual Studio Professional 2013 (Update 1); and
• F# 3.1 compiler.

Despite the self-answer, the floor is wide open to better solutions as what I've got currently doesn't really cut mustard.

我使用asp.net WebApi Help Page从源代码的注释生成文档。而且我之前使用过doxygen来生成文档。doxygen可以解析注释中的markdown 语法并输出格式良好的文档。但是WebApi 帮助页面现在无法解析 markdown 语法。

例如，foo函数的注释中包含Markdown 注释，它会像### Markdown comments *It will return "foo" *It always returns "foo"WebApi Help Page一样输出。

我正在为我的 ASP.NET Web API 帮助页面使用 XML 文档，如下所示。我想知道是否有办法在评论中包含 html，以便将其呈现在网页上，而不是被删除/忽略/转义。
具体来说，我正在寻找一种创建换行符的方法，但是能够创建项目符号列表等会很棒！

前/我希望能够做这样的事情：

并让它显示在帮助页面上，如下所示：

而不是这个：（在这种情况下，<br/>以某种方式被删除 - 如果我尝试使用<p>标签，它们只是被转义）

*我已经尝试过<para>多个帖子建议的标签作为工具提示，但这在我的帮助页面上不起作用。

任何建议都非常感谢！

我正在开发一个基于用户输出不同响应的 API，我目前正在使用 ResponseType 属性来描述返回的响应类型，但这仅允许我指定一种响应类型，这将在用户。

有什么方法可以自定义帮助页面以显示用户将获得的响应类型？

我正在尝试<see cref="">在我的 API 的 XML 文档标签中使用标签，但它们在帮助页面中显示为空白。

因此，对于描述，我想说：

"获取或设置关联Item的值。"

其中Item是指向 API 中另一个对象的链接。

相反，我得到：

“获取或设置关联的值。”

所以<see cref="">标签被忽略了。我什至尝试使用此处的示例，以防我的声明错误，但这也不起作用。

有没有其他人有这个问题？新的 Web API 2 帮助页面对 XML 文档标签的支持程度如何？有谁知道是否可以手动添加对此的支持，如果没有？

Postman是一个可以用来轻松测试 RESTful Web 服务的工具。

如果 Asp.Net 项目将WebApi与 WebApi 结合使用，则可以为暴露的 RESTful Web 服务自动生成帮助页面文档。

这个自动生成的文档很好，但可以通过增加可访问性使其变得更好。

如何将这些技术结合起来生成可以在 Postman 中导入的 JSON 文件？

我正在记录一个 API，我想知道如何将响应格式链接到我创建的 ViewModel。ViewModel 有我希望用户浏览的注释。问题是我的控制器返回HttpResponseMessage而不是实际模型本身，因此 WebAPI 帮助页面跳过了记录这一点；

在 HelpPageConfig.cs 我添加了以下内容；

我该如何解决这个问题，并使用 APIExplorer 在帮助页面中创建一个链接。还是必须手动完成？

示例控制器；