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

I have a problem with API help page, it works well until I changed the route of API.

Let see this example, I have a booking API for controlling users' booking action:

And I have a route for getting booking

So the generated page has only 1 documentation for booking, like this :

There is no documentation for POST action. I don't know why. Thank you so much !

I've a Web Api Service in C# and I created a Help Page, that added a folder "Areas" with a MVC project.

I tried to make my SERVICE/help page into my default page, changing the controller on the routing but of course, I couldn't do it because "help" is not a controller in my Web Api Service.

How can I redirect to the help page by default when someone acess to my service?

Thanks and kind regards.

我只是想知道 Web API 帮助页面是否有任何包或扩展来支持 Sdammann 包以外的版本控制。

我想要这样的东西

然后 Api 帮助页面会显示最低支持的版本。

我想为我的 API 的每个版本创建一个单独的帮助页面。例如，用户可以转到 /help?v=1 来查看 1.0 版路由，而 /help?v=2 可以查看 2.0 版路由。

使用SDammann.WebApi.Versioning，我添加了一个Version属性，VersionedApiExplorer该属性将仅返回已定义版本的路由，并将版本添加为构造函数的参数。然后我尝试了这个：

但这给了我以下错误：

我只添加了一个服务实例config.Services.Replace(typeof(IApiExplorer), new VersionedApiExplorer(GlobalConfiguration.Configuration, "1"));——让配置工作，所以我可以测试我的帮助控制器。然后尝试了这个：

这给出了我上面收到的相同错误。我知道我通常会使用this.Configuration.Services.GetApiExplorer()，但我不知道如何使用它来获取VersionedApiExplorer. 我知道我可以ApiExplorer直接在控制器中实例化适当的，但如果可能的话，我更愿意将它保存在我的配置文件中。

所以我有两个问题：

1. 如何VersionedApiExplorer向我的配置对象添加两种类型的服务？
2. 如何在帮助控制器中检索适当的服务？

还是我可以采取完全不同的方法来实现相同的目标？

谢谢！

我有一个使用 ASP.NET WEB API 开发的 rest api。我使用帮助页面 nuget 包来创建文档。我遇到的一个问题如下。对于我的模型对象，我有 xml 文档注释，它们成为模型每个成员的帮助页面上的描述。我希望描述的某些部分位于新的一行，但评论中的所有内容都作为一个段落出现。我试图<br/>在评论中添加，但没有帮助。有谁知道如何实现这一目标？

我有一个使用 Microsoft.Asp.Net.WebApi.HelpPage nuget 项目（版本 5.2.2）的 ASP.NET WebApi 项目添加 app.UseWebApi(config); 当我尝试访问帮助上的方法时到 startup.cs，我收到以下错误：

调用 HttpRequest.GetBufferlessInputStream 后不支持此方法或属性 [堆栈跟踪]： System.Web.HttpRequest.EnsureFiles() +3274833
System.Web.HttpRequest.get_Files() +12
System.Web.HttpRequestWrapper.get_Files() +28...

删除线，问题就消失了。

我正在使用针对 .Net 4.5.1 版的 VS2013 并使用 IIS Express 进行调试。截至今天，所有 Nuget 包都在运行最新版本

我正在使用 Web API 帮助页面，我希望能够包含指向其他方法的链接。我从Web API 2 帮助页面没有处理 XML 文档标签？不支持使用 <see cref='...'> 。

有没有比在文档中编写我自己的 <a href='...'> 链接并使用Web Api 帮助页面中描述的方法更好的选择 - 不要在 xml 文档中转义 html来获取这些 <a> 标记输出帮助？对于未来的任何变化，它似乎都非常脆弱。

我能想到的唯一选择是强制 API 资源管理器运行两次——一次缓存所有不同的路由及其相应的帮助页面 URL，第二次实际生成文档。但我不确定在哪里挂钩（或者是否有可能）

我无法弄清楚如何在我的 Web Api 中获取帮助页面以显示除无以外的资源描述的任何内容。它有 IHttpActionResult 链接，然后是“无”。在那之后。我通过添加config.SetActualResponseType(typeof(ComplexType), "Controller", "Action");到 HelpPageConfig.cs 使我的示例正常工作。我的控制器如下所示：

我不知道 HelpPageConfig.cs 或其他任何地方缺少什么。也许一双新鲜的眼睛可以捕捉到一些东西。在此先感谢您的帮助！

我使用 ASP.NET Web API 的帮助页面。

但我发现对象作为请求模型存在问题。

和班级

我在参数的测试模式窗口中看不到位置字段。如果我在行动中通过现场-这是正确的

请帮我在 api 帮助页面上添加一个 multipart/form 数据参数。

我正在使用Microsoft.AspNet.WebApi.HelpPage.VB 5.2.2。

我想在 api 帮助页面上添加 CustomerName、fdStreet1、fdStreet2 参数信息。我怎样才能做到这一点？

这是我到目前为止所拥有的。