何时以及如何正确使用 [ResponseType(typeof(...))]？

Question

我正在做一个项目，我有一个带有Get(int id)、GetElements()、UpdateElement(int id, Element element)、AddElement(Element element) 和DeleteElement(int id) 的基本控制器。 每个方法都使用[Route] 和[Get]... 注释并返回IHttpActionResult。

我对@9​​87654329@ 感到困惑。它是干什么用的？何时以及如何正确使用？

我应该写这样的东西吗？ [ResponseType(typeof(IEnumerable<Element>))] 为GetElements()？

谢谢！

Answer 1

[ResponseType()] 属性有助于创建 RESTful Web API 以及通过 Swagger / Swashbuckle 自动生成文档。

例如，基于 id 返回项目的方法可以这样编写

public YourClass Get(int id)
{
    var item = repo.GetById(id);
    return item;
}

但是，如果找不到该项目，它将返回 null，而不是 404。

所以最好写成

[ResponseType(typeof(YourClass))]
public IHttpActionResult Get(int id)
{
    var item = repo.GetById(id);
    if (item != null)
    {
        return this.Ok(item);
    }

    return this.NotFound();
}

在这里查看更多用法http://www.asp.net/web-api/overview/web-api-routing-and-actions/create-a-rest-api-with-attribute-routing

另请参阅自定义 Swashbuckle 以及它如何使用 ResponseType 属性来确定文档https://azure.microsoft.com/en-gb/documentation/articles/app-service-api-dotnet-swashbuckle-customize/