自动生成返回类型为 HttpResponseMessage 的帮助页面

我希望能对 Web api 自动生成的帮助页面进行一些说明。

据我所知，如果我返回一个类型，它将自动生成该操作的帮助页面和示例。但是，如果我使用 HttpResponseMessage ，那么它无法猜测响应是什么，只能对请求参数做出假设，这是可以理解的。

我使用 HttpResponseMessage 的原因是因为建议在它可能不同于 200 时指示您希望返回的状态代码。

So 最佳实践方法是什么能够返回您想要的状态代码，但仍然有帮助页面计算出您要返回的类型？

对于需要返回 HttpResponseMessage 的这些场景，解决方法是使用 HelpPage 提供的一些帮助程序来指示该特定操作的实际返回类型。 可以在路径中找到以下代码Areas\HelpPage\App_Start\HelpPageConfig.cs

//// Uncomment the following to correct the sample response when the action returns an HttpResponseMessage with ObjectContent<string>.
//// The sample will be generated as if the controller named "Values" and action named "Post" were returning a string.
//config.SetActualResponseType(typeof(string), "Values", "Post");

Note:
在即将发布的版本中，我们将引入一个新属性，称为System.Web.Http.Description.ResponseTypeAttribute您可以向其提供System.Type指示响应的实际类型。这样你就可以返回HttpResponseMessage or IHttpActionResult从您的操作中仍然期望 HelpPage 能够正常工作。