最近在写webapi,在写post请求接口时遇到了不少的问题,在此记录下来。
post请求的参数和get请求有点不一样,我们知道get请求的参数是通过url来传递的,而post请求则是通过http的请求体中传过来的,WebApi的post请求也需要从http的请求体里面去取参数。
单个参数错误写法
//错误的js ajax post写法 $.ajax({ type:"post", url:"http://localhost:44670/IOF/test/Test1", data:{ name:"张三丰"}, success:function(data,status){ console.log(data); console.log(status); } });
//错误的webapi写法 [HttpPost] public string Test1(string name) { return name; }
上面的写法看似很正确,实际上结果这这样的
而且我们在asp.net webapi里打上断点是无法跳转到断点的。
我们更改asp.net webapi(在参数中添加 [FromBody] ),如下
[HttpPost] public string Test1([FromBody] string name) { return name; }
我们仍然用上面的js来调用接口Test1
此时就可以看到程序跳转到了断点处,但是我们发现name是空值单个参数正确写法
//正确的js写法 $.ajax({ type:"post", url:"http://localhost:44670/IOF/test/Test1", data:{ "":"张三丰"}, success:function(data,status){ console.log(data); console.log(status); } });
//正确的webapi写法 [HttpPost] public string Test1([FromBody] string name) { return name; }
此时我们就看到Status Code是200OK了,webapi也拿到了传递过来的name值了
我们一般的通过url取参数的机制是键值对,即某一个key等于某一个value,而这里的FromBody和我们一般通过url取参数的机制则不同,它的机制是=value,没有key的概念,并且如果你写了key(比如ajax参数写的{name:"张三丰"}),后台反而得到的name等于null。
上面是传递1个参数,那如果是多个呢?是不是ajax可以这样写{" ":"张三丰"," ":"13200000000"},后台可以这样写[FromBody] string name,[FromBody] string phone
多个参数错误写法
//错误的写法 $.ajax({ type:"post", url:"http://localhost:44670/IOF/test/Test1", data:{ "":"张三丰","":"13200000000"}, success:function(data,status){ console.log(data); console.log(status); } });
//错误的写法 [HttpPost] public string Test1([FromBody] string name, [FromBody] string phone) { return name + ":" + phone; }
说明这样是行不通的。
多个参数正确写法
//正确写法 $.ajax({ type:"post", url:"http://localhost:44670/IOF/test/Test1", data:{ name:"张三丰",phone:"13200000000"}, success:function(data,status){ console.log(data); console.log(status); } });
//test:新建一个类如包涵所有的参数 public class test { private string name; private string phone; public string Name { get{ return name;} set{ name = value;} } public string Phone { get{ return phone;} set{phone = value;} } }
//正确写法 [HttpPost] public string Test1([FromBody] test model) { return model.Name; }
如果我们的webapi都是post,而且每个都是多个参数,那岂不是要创建很多的类来接收post过来的值?作为一个爱偷懒的程序员,那怎么可以!!
最优写法
// JSON.stringify():这个函数的作用主要是为了序列化对象的。 $.ajax({ type:"post", url:"http://localhost:44670/IOF/test/Test1", contentType: 'application/json', data:JSON.stringify({ name:"张三丰",phone:"13200000000"}), success:function(data,status){ console.log(data); console.log(status); } });
//webapi 要换个写法,dynamic:序列化 [HttpPost] public string Test1(dynamic obj) { return obj.name; }
我们把js要传递的参数序列化,然后通过后来dynamic来接收序列化的值。
总结
以上就是post请求参数传递的几种方法,推荐使用最好一种【最优写法】。