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

我在这里阅读了有关 Web API 帮助页面的附加信息。数据注释实际上为文档提供了附加信息。但我想知道是否有提供额外信息而无需数据注释？

如果是，那怎么办？

如果没有，那么无论如何都要用数据注释覆盖附加信息，例如

显示需要写在附加信息中，但是如果我想显示“此字段是必需的”或类似的内容怎么办？

谢谢

编辑如图所示，如果可能的话，我想在没有数据注释的情况下更新附加信息。

我正在使用 Team Foundation Server 2013，并且将每晚构建配置为部署 Web 应用程序。Web 应用程序正在使用依赖于内置 XML 文档文件的 Web API 帮助页面。

我目前将这些 XML 文件输出到 App_Data 文件夹。这些在部署期间不会被复制到服务器。我尝试签入文档文件，但是当构建过程尝试重新生成它们时，由于文件是只读的，因此导致访问错误。

我目前在项目中包含的 App_Data 文件夹中有一个占位符文本文件，以确保创建该文件夹，但我必须手动复制文档文件才能使帮助页面按预期工作。

强制复制这些文件的正确/最佳方法是什么？

谢谢

我已经阅读了一篇文章http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages并且效果很好。但我更愿意在发送这些响应时添加所有可能的响应和条件。任何分析每个 WebAPI 方法的工具，找到所有有响应的地方，为什么会发生并自动创建有关它的文档？

即我有以下代码：

我想要文档，其中描述了该方法的返回：

1. 当方法成功完成并找到元素时，StatusCode = 200 和元素列表
2. 当方法成功完成且未找到任何元素时，StatusCode = 204
3. 未找到位置时 StatusCode = 400（获取编辑请求的条件）以及带有消息和 CustomStatusCode 的详细响应

我正在使用 Microsoft 的 webapi 帮助页面 nuget 包。

当我最近添加了一个新控制器时，我在帮助页面中的所有路由都出现了两次：

和

如何删除这些重复项？

令人惊讶的是，我去年添加的一些较旧的控制器并没有发生。

我能想到的唯一区别是在我用作dynamic响应类型的新控制器中，但我也在ResponseTypeAttribute帮助页面中使用了 so，DTO 模型正确显示。

我一直在 nopcommerce 工作并尝试为客户端应用程序实现 Web API Restful 服务。我添加了一个 Web Api 项目并将我的 WebAPI 项目的输出目录设置为主要的启动项目，即 Nop.Web 项目。所以实际上 Nop.Web 项目实际上被部署了，我们在那个主项目中有一个 webapi 项目的子文件夹。我们面临的问题是我无法访问为 webapi 项目生成的帮助页面。我无法确定问题所在。请有人帮我解决这个问题。

我们已经创建了一个 web api 项目，其中我们暂时使用了基本身份验证。我们使用 nuget 包来生成 Web Api 帮助文档，因此它为 Web Api 帮助添加了新的区域、控制器和视图。我们在 IIS 上托管了 web api。现在，任何人都可以通过浏览 Web Api url“ http://localhost/WebApi/Help ”来浏览 Web Api 帮助。我们想要验证帮助页面（在 MVC 中实现）。这里的问题是我的 web api 使用基本身份验证，我想创建一种机制，以便在对 Web Api 帮助页面的任何请求之前对 web api 帮助进行身份验证。

为此，我创建了一个“AccountController”、“Login”页面。我还创建了一个身份验证过滤器并装饰了“HelpController”（它具有用于呈现帮助页面的所有操作）。登录页面代码：

我创建了一个继承 WindowsIdentity 类的身份类

当我在输入有效凭据后单击登录时，它将被重定向到帮助控制器的索引操作。由于我有身份验证过滤器，它将首先调用“OnAuthentication”方法。在这里，它总是将“context.HttpContext.User.Identity.IsAuthenticated”标志设为假。认证过滤器属性如下：

请提供您的意见。

我正在寻找用于 asp.net web api 应用程序的文档工具或生成器。该工具必须允许编辑 API 方法或参数的描述/摘要。我可能需要这个，以允许不同的团队说 PM、QA 也编辑文档，这样它就不必总是开发人员。

请建议任何支持此要求的好工具。

我正在尝试将ASP.NET 帮助页面设置为在现有 MVC 项目中运行，尽管指向同一解决方案中 Web API 项目的文档文件。约定在它正在记录的 Web API 中运行帮助页面，但在这种情况下，我希望它在同级 MVC 项目中。

Web API 项目将其文档 XML 文件输出到 MVC 项目内的文件夹中。

我已经在 MVC 项目中安装了Microsoft.AspNet.WebApi.HelpPage NuGet 包。这将创建一个类\Areas\HelpPage\App_Start\HelpPageConfig.cs，并且在该类的Register方法中，我已将XmlDocumentationProvider路径传递给 Web API 的文档文件。

但是当我加载页面时，除了标题和占位符描述之外，它是空的。

在调试该HelpController.Index方法后，我可以在返回IApiExplorer的结果中看到它们_apiDescriptions是空的。

但是，如果我将帮助页面直接安装到 Web API 项目中并调试相同的方法，我可以看到_apiDescriptions现在存在。

谁能解释 Web API 项目正在做什么或已经配置了 MVC 项目没有做什么或没有配置？

我以前来过这里，但这次我比以前走得更远。我一直在关注本指南并完成了它所说的一切。如果我导航到http://localhost:61589/help我实际上看到了帮助页面，但只有介绍，没有描述。

在我的控制器中，我有这样的评论（总是这样）：

在生成的 XmlDocument.xml 我有这些成员：

但是它们没有出现在实际的帮助页面上。有谁知道为什么会发生这种情况？

我正在使用 Microsoft ASP.Net Web API 2.2 帮助页面 5.2.3 版，并且正文参数的附加信息显示“无”。我无法让它显示任何有用的信息。其他信息已正确填充。

样本类：

据我所知，附加信息应填充为“必需”或错误消息中的文本。我已经尝试过这个答案： https : //stackoverflow.com/a/35920075/5910024 无济于事。