WebApi POST没有[FromBody]吗?

时间:2014-11-22 09:53:03

标签: c# post asp.net-web-api

我有这个控制器动作:

 [HttpPost]
 [ActionName("aaa")]
 public HttpResponseMessage aaa(Z z) //notice  - no [FromBody]
 {
    return Request.CreateResponse(HttpStatusCode.OK, 1);  
 }

Z的位置:

public class Z
 {
   public string a { get; set; }
 }

但是当我通过fiddler发布时:

POST http://localhost:11485/api/profiles/aaa HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Host: localhost:11485
Content-Length: 3
Accept-Encoding: gzip, deflate
Accept-Language: en-US,en;q=0.8,he;q=0.6
Cache-Control: no-cache
Connection: keep-alive

a=1

我实际上可以看到它正在运作:

enter image description here

问题:

如果是这样,没有[FromBody]属性,它如何工作?我还需要/不写这个属性吗?

此外,不写这个属性的情况是什么 - 会导致问题?

1 个答案:

答案 0 :(得分:13)

绑定与MVC和Web API不同。默认情况下,ASP.NET Web API将来自请求消息正文的复杂类型与来自URI,查询字符串等的简单类型绑定。由于您指定了Z,这是一个类(复杂类型),它会填充操作方法来自body的参数,无需指定[FromBody]。另一方面,如果您的请求是http://localhost:11485/api/profiles/aaa?a=1而没有正文,则它不会自动绑定到您的复杂参数。在这种情况下,您需要指定[FromUri],如下所示:public HttpResponseMessage aaa([FromUri]Z z)

另一方面,请说您的操作方法是public HttpResponseMessage aaa(string a)。我们现在有string,这是一种简单的类型。在这种情况下,没有消息正文的http://localhost:11485/api/profiles/aaa?a=1将允许Web API正确绑定参数,而无需指定[FromUri]。现在,如果您想在这种情况下从body绑定,则需要指定public HttpResponseMessage aaa([FromBody]string a)。当然,对于此=1application/x-www-form-urlencodedaFromUri的密钥名称必须为FromBody

底线 - 您的参数(简单类型或复杂类型)决定了Web API的绑定方式。要使其与默认行为的工作方式不同,您需要通过[FromBody]或{{1}}进行说明。

PS。无论我上面提到的是什么,纯粹是为了好的旧的ASP.NET Web API(包括2)。在ASP.NET 5.0中,a.k.a ASP.NET vNext或ASP.NET MVC 6.0,MVC和Web API已经统一。要使它从body绑定复杂类型,您必须指定{{1}}。