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

我可以使用传统的 asp.net 引擎来渲染帮助页面，但是在 OWIN/katana 上托管 Web API 服务时，我怎样才能获得相同的效果。

我尝试添加HelpPageConfig.Register(config);无济于事class Startup。

我正在定制 ASP.NET Web API 帮助页面。

我正在寻找显示属于 URL 指定的控制器的方法的最佳方法。我的控制器都以“ ws_ ”为前缀。

我在 RouteConfig 中添加了一个条目来识别包含字符串“ ws_ ”的 URL，如下所示：

这是我的帮助控制器。我试图让 WsContext 方法去除不属于通过 URL（即mysite.com/ws_test ）传递的控制器（即ws_testController ）的方法。

我目前收到以下错误：

路由表中没有路由与提供的值匹配。

我有一个 Web API 项目，几个月前当我们开始开发时，我在其中手动删除了Areas文件夹。现在一切都完成后，我想添加 API 帮助页面，但它没有按预期工作。

我为帮助页面安装了 nuget 包。

我取消注释行HelpPageConfig.cs

我检查了生成文档文件（到 App_Data 文件夹）

当我打开http://localhost:51665/help我得到这个：（没有显示方法）

知道有什么问题吗？如果我从头开始新项目，一切正常。

我在传递标头内容类型的服务器上打了一个 api 调用。

现在在 web api 帮助页面上，文档希望显示在进行 web api 调用时传递了这个 Headers

将以下代码用于该方法的文档。

但是如何在这个 xml Documnet 中传递标题？

我添加了帮助页面 Nuget 包来为我的 Web API 创建文档，但它对我不起作用，没有显示任何 API 方法。

我未注释行：

我选中了 XML 文档文件框并将路径设置为App_Data/XmlDocument.xml

我不使用 Glimpse，因为这里写了很多解决方案。

我什至为具有授权的帮助页面安装了 nuget 包，但它没有帮助

这有什么问题？如果我启动一个空项目，它就可以正常工作，但是这个 API 太大而无法重新开始。

将FluentValidation与 WebAPI 结合使用，我试图展示在属性上实现的规则。

我正在使用 Microsoft.AspNet.WebApi.HelpPage 程序集，它将为我的 API 生成帮助页面。我希望能够枚举验证规则，以便可以在帮助页面上显示所需的属性和长度。

以前，我会为自定义属性执行此操作，如下所示：

这将在帮助页面的附加信息部分添加所需的文本。在使用FluentValidation的情况下，不再设置所需的类型。现在是这样的RuleFor(x => x.MyProperty).NotEmpty();

如果有帮助，记录注释的代码如下：

在调用此 GenerateAnnotations 例程时，我想添加将查看属性并获取分配的所有流畅属性并添加文本的逻辑。

也许以某种方式使用FluentValidation.Internal.PropertyRules优雅地枚举属性？

我正在使用 Microsoft Web API 控制器类 (v2.1) 编写 Web 服务，并在每个类和方法的开头使用 XML 来自动生成文档。生成的文档有一个主页，其中列出了每个类和方法以及一个查看更多详细信息的链接。

不幸的是，这个主页（或索引）页面显示的课程在我看来是随机顺序，因此很难找到您想要的课程。

有没有办法让它们按字母顺序出现？

我有这个项目，它只是一个 Web API 项目。在过去的某个时候，我删除了 HelpPages，并让应用程序使用了 OWIN。现在我被要求添加我已经完成的 API HelpPages。我已将我的Startup类设置为如下所示：

这样我的帮助页面路线就可以了。据我所知，这应该可以工作，但问题是 ApiExplorer 不会撤回任何描述。

在我的ConfigureWebApi方法中，我删除了格式，我已将其注释掉，但它仍然不起作用，这是方法：

我实际上编辑了HelpController并在返回视图行上放置了一个断点，这就是我知道 ApiExplorer 没有描述的方式：

我在某处读到，如果我这样做：

我应该看到描述，但它仍然不起作用。因此，我在其他地方阅读以设置我的项目以输出 xml 描述文件并配置HelpPageConfig文件以使用 documentProvider。我生成了 Xml 描述文件，并且可以验证我的描述是否在其中，这是一个片段：

我取消注释了HelpPageConfig中的行，如下所示：

并确保 XML 文件位于 App_Data 文件夹中。这些名称都是正确的，但是当我运行我的项目时，我仍然没有从 ApiExplorer 中得到任何描述。

所以，正如你所看到的，我已经束手无策了。我希望有人以前遇到过这个问题并且知道如何解决它。如果你这样做，请帮助！

我有多个控制器端点，路由如下：

它们都有这样的方法签名（访问修饰符和返回类型被省略）：

自定义模型绑定器允许我像这样发布到端点：

这很好用！但是，帮助页面文档生成过程会忽略所有这些方法。

如果我像这样删除 modelbinder 属性：

它仍然不起作用。只有当我添加[FromUri]到参数并{objectIds}从路由属性中删除它才会起作用：

但这会生成一个不需要的 uri，如下所示：

如何获取帮助页面文档流程以识别我的端点？

我在 VS2012 中使用 nuget 包 Microsoft.AspNet.WebApi.HelpPage。我想知道是否有任何导出可能性来创建 .chm/word/pdf/etc

谢谢。吉列尔莫。