WebAPI 2返回类型不会破坏帮助文档网站

Question

有没有办法在不破坏超级方便的帮助文档的情况下为我的API方法使用（显然更喜欢的）IHttpActionResult返回类型？当我回来 List<T> 从我的方法，我得到非常描述性的帮助文档。当我返回IHttpActionResult时，我得到了无用的帮助文档。为什么给我们这么酷的玩具，然后建议我们使用打破玩具的东西？我是否错过了如何将文档网站与MS首选样式一起使用的优秀资源？

Answer 1

您应该能够将ResponseTypeAttribute附加到您的操作方法，该操作方法指定使用HttpResponseMessage或IHttpActionResult时的预期返回类型。然后，ApiExplorer在生成文档时应该选择此项。

来自网站：

  

当声明的返回类型为HttpResponseMessage或IHttpActionResult时，使用此选项指定操作返回的实体类型。生成ApiDescription时，ApiExplorer将读取ResponseType。

如果您使用其他API来生成文档，您应该检查它们是否支持它或将其包含在问题中，也许这里有人知道。