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

Question

有没有一种方法可以在不破坏超级方便的帮助文档的情况下为我的 API 方法使用（显然是首选的）IHttpActionResult 返回类型？当我回来 List<T> 从我的方法中，我得到了非常详细的帮助文档。当我返回 IHttpActionResult 时，我得到了无用的帮助文档。为什么给我们这么酷的玩具，然后建议我们使用破坏玩具的东西？我是否缺少有关如何将文档网站与 MS 首选样式一起使用的重要资源？

Answer 1

您应该能够将ResponseTypeAttribute 附加到您的操作方法中，以指定使用HttpResponseMessage 或IHttpActionResult 时的预期返回类型。然后，ApiExplorer 在生成文档时应将其提取出来。

来自网站：

当声明的返回类型为 HttpResponseMessage 或 IHttpActionResult 时，使用它来指定操作返回的实体类型。 ApiExplorer 在生成 ApiDescription 时会读取 ResponseType。

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