c# - Asp.Net Web API中ResponseTypeAttribute的主要用途是什么

Question

你可能认为这个问题可能会重复，但我找不到任何有用的答案来回答我的问题。

这是我的 Controller 操作

[HttpPost]
[ResponseType(typeof(UserInputModel))]
public IHttpActionResult GetUsers(UserInputModel userModel)
{        
    if(adminBao.GetUsers(userModel)==null)
    {
       return NotFound();
    }
    return Ok(adminBao.GetUsers(userModel));
}

当我删除 [ResponseType(typeof(UserInputModel))]

时，输出有什么不同

我知道这用于提示 web api 关于通用返回类型...但是它对响应有什么影响？

有人能帮我理解一下吗

Answer 1

But what impact it make in the response?

对实际响应没有影响。它主要用于文档目的。

它的主要目的是让 ApiExplorer 在 Action 定义中使用抽象时知道 Action 返回什么类型。

Explorer 无法从 HttpResponseMessage 或 IHttpActionResult 或其衍生产品之一中确定。

这样在生成文档时它可以显示正确的类型。

ResponseTypeAttribute Class

Use this to specify the entity type returned by an action when the declared return type is HttpResponseMessage or IHttpActionResult. The ResponseType will be read by ApiExplorer when generating ApiDescription.