问题标签 [asp.net-web-api-helppages]

如何避免显示我的方法的两个版本的帮助页面？

如您所见，我为 设置了自定义路由/api/property/search/{finnId}，但我不希望使用查询参数的路由显示在帮助页面中。有什么办法可以解决这个问题？我正在使用 ASP.NET Fall 2012 BUILD preview 中的内置帮助页面。

顺便说一句，不要担心它说的事实POST，我已经把它切换到了GET，但我得到了相同的结果。

ASP.Net Web Api 帮助页面似乎会自动确定参数是否在请求 Uri 或正文中。如何记录作为 QueryString 参数的选项参数？

例如，我可能有一个 RESTful Url，例如

其中“relatedToBookId”是可选的 queryString 参数。

通常将 FromUri 或 FromBody 参数放入注释中

我有我的 web api，我添加了web api 帮助页面来自动生成我的文档。它对于列出我的参数的方法非常有用，但我有一个这样的方法：

而且，在我的帮助页面上，它只在属性部分列出了命令参数。但是，在示例请求部分，它列出了我的CreateSessionCommand类的所有属性。

参数

姓名 | 说明 | 附加信息

请求 | 没有可用的文档。| 在请求正文中定义此参数。

我希望它列出我CreateSessionCommand班级中的所有属性。是否有捷径可寻？

我正在使用 Web API 帮助页面生成器生成我的 API 文档。但问题是帮助页面生成器无法为带有 Enum 参数的方法生成文档。这也发生在对象和动态类型的参数中。

这是我的方法：

这是生成文档：

但正确的形式是：

当我转到 API 模型文档时，参数在那里，但没有描述。

就像这样：

这是帮助页面生成器中的错误吗？如何修复我的页面示例？

有没有办法让 ApiExplorer 自动生成请求样本？

我尝试使用：

在 HelpPageConfig.cs 中，但出现了 2 个问题：

1. 它要求我为特定的控制器和操作定义特定的类型，并且我正在寻找更通用的东西，如果添加了新的控制器\类型，则不需要添加\更改代码。

2. 每个控制器\动作我只能使用一种类型，因此我无法为在其请求正文中接收 2 种复合类型的动作生成完整的请求样本。

关于如何解决\解决这些问题的任何想法？

我有一个控制器，我想为使用 ASP.NET Web API 帮助页面生成文档。

ApiController当我直接从文档继承时出现：

但是当我从基本控制器继承时，它被省略了：

...

我已经切换到委托而不是继承，但我想知道如何使它与继承一起工作。

我想去http://myserver并能够将帮助页面作为默认主页，所以客人首先http://myserver应该看到的是帮助页面。

我有这样的默认路由设置：

然后我的帮助页面区域注册设置如下：

当我将 RouteConfig 更改为时controller，"Help"我得到：

未找到视图“索引”或其主视图，或者没有视图引擎支持搜索到的位置

当我将帮助页面路由更改为"{controller}/{action}/{apiId}"我的 AttributeRoutes 时停止工作。

是否有一些简单的方法可以使 ASP.NET 帮助页面成为默认主页？

我已经为 Web Api 2 安装了正确的包

但是帮助区域没有被映射并且返回 404（Web Api 工作正常）。我使用 Microsoft.Owin.Host.SystemWeb 作为主机。下面是我的启动代码。

请使用默认 (bin\EnterpriseServices.XML) 值在项目属性中启用“XML 文档文件”或在 App_Start\SwaggerNet.cs 中编辑值

我正在使用 MVC4 WebAPI 并且有一些问题；

1. 我们如何定义参数页面[附加信息]的“内容”？？
   默认情况下，此状态为“在请求正文中定义此参数”？？

2. 我们如何在参数页面[示例]上定义示例数据？？
   例如，假设一个字符串值应该是“COME”或“GO”，我怎样才能在帮助页面上得到说明，而不是获取它们的默认“字符串”值？

3. 哪里是放置一些约束的正确位置，例如预期的标头值或 API 将产生的可能的响应/错误，以便它出现在帮助页面上？