ASP.NET MVC WebAPI请求

提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

基础：

首先，先创建一个“ASP.NET 空Web应用程序” ：

然后添加对 “System.Web.Http” 和 “System.Web.Http.WebHost” 的引用：

再添加对“System.Net.Http” 的引用：

由于需要用到对Json数据的处理，所以还要添加对 “Newtonsoft.Json” 的引用。

这里需要注意一下：

如果开始不添加对“Newtonsoft.Json”的引用，在项目运行时就会报错，具体报错原因稍后再说。

对四个类库的引用：

然后新建一个类，用于注册默认路由映射，这里类名为 WebAPIConfig ：

添加Global.asax文件，在 Application_Start 方法中初始化路由映射：

protected void Application_Start(object sender, EventArgs e)
{
//在应用程序启动时注册路由映射
WebAPIConfig.Register(GlobalConfiguration.Configuration);
}

记得引入命名空间：

using System.Web.Http;

注意：

上面我们提到，如果开始时不引用 “Newtonsoft.Json”，那么在运行时注册路由映射这里就会报错：

创建名为Controller的文件夹，然后添加一个类且类名以 Controller结尾，这里为UserController 。让这个类继承自 ApiController 基类：

创建名为Model的文件夹用来存放实体类，添加Users类：

在 UserController 类中，添加一个 GetUser() 方法，模拟一些数据：

//引入命名空间
using System.Web.Http;
using X_1_FirstWebAPI.Model;namespace X_1_FirstWebAPI.Controller
{
public class UserController : ApiController
{ public List<Users> GetUser()
{
var userList = new List<Users> {
new Users{ Id=1,UName="张三",UAge=12,UAddress="海淀区"},
new Users{Id=2,UName="李四",UAge=23,UAddress="昌平区"},
new Users{Id=3,UName="王五",UAge=34,UAddress="朝阳区"}
}; var temp = (from u in userList
select u).ToList();
return temp;
} }
}

我们之前添加的路由规则为 "api/{controller}/{action}/{id}" ，所以，我们在浏览器中访问数据的url为 http://localhost:****/api/controllerName/actionName 的形式，在这里即是 api/user/getuser :

进阶：

请求的后台Action方法仍为上篇文章中的GetUser() :

也可以用$.ajax({type:"get"}) 方式，正确的获得了返回数据：

二、传递一个参数的Get请求

通常我们需要传递参数只需要指定ajax方法的data属性即可： data:{"name":"赵大宝"}

后台正确的返回数据：

三、传递两个或多个参数的Get请求

按照上面的方法，对于多个参数我们可以很容易就写出来： data:{"name":"赵大宝","age":12}

后台正确的返回数据：

四、无参数的Post请求

我们可以使用$.post() 或$.ajax({type:"post"}) 来发起post请求：

后台正确的返回了数据：

五、传递一个参数的Post请求：

首先这里需要提醒大家一下，我们在修改完后台代码后，如果没有重新生成项目，那么在请求时就会报错：“未找到与请求***匹配的HTTP资源” ：

所以，我们只要我们修改了后台代码，就一定要重新生成一下：

不过，当我们重新生成项目，再次发送请求，看到的仍然是404错误，再次检查一番代码，也没有发现是哪里的问题。

事实上，ASP.NET Web API能够正确的识别我们的UserController控制器处理Post /api/user ，但却不能找到一个可以接受的方法来处理请求。

也就是说，Web API接收到的请求能够找到User控制器，但在该控制器中找不到名称为Def 的这个Action。

那我们要怎么来解决呢？

通过搜索MSDN上Web API官网中的说明，我们可以找到下面的一段介绍：

即在Action 方法中我们需要使用 [FromBody] 属性标签来标明属性。

修改后，再次发送请求，我们可以看到，Status Code 为200，请求发送成功。

可以看到，在post请求中，方法的参数必须要用 [FromBody] 属性来修饰才可以， [FromBody] 就告诉Web API 要从post请求体重去获取参数的值。

但让我们诧异的却是，后台返回的数据中name的值为空。

通过调试，我们可以看到，后台Action 中接收到的name值为null。

通过上面的测试我就也能够猜测到，Web API 要求请求传递的 [FromBody] 参数，肯定是有一个特定的格式，才能被正确的获取到。而这种特定的格式并不是我们常见的 key=value 的键值对形式。Web API 的模型绑定器希望找到 [FromBody] 里没有键名的值，也就是说，不是 key=value ，而是 =value 。

现在，咱们把data中的key设置为空，然后再次发送请求：

测试可见，后台正确的接收到了数据:

六、传递两个参数的Post请求

按理说，一个参数的请求实现了，那么传递两个或者多个参数也就很顺利了，对于两个参数的后台接收方法，我们可能会这样来写:

但事实证明，这样是错误的。

那到底两个或者多个参数我们要怎样来定义呢？

再次查看官网中的介绍，我们了解到：

也就是说，[FromBody] 修饰的参数只能有一个。我们需要对传递的多个参数进行封装才行。

这里，我们可以将 Name和 Age 封装成一个Student 类：

前台页面再次发送请求：

Status Code为200，请求成功，并正确获取到后台返回的数据：

这里，我们通过上面图片中的请求头数据可以看到，Form Data 的格式是 key=value&key=value 这种表单数据格式 Name=%E8%B5%B5%E5%A4%A7%E5%AE%9D&Age=13 ，我们平时使用的比较多的一般为json格式。这里，我们使用 JSON.stringify() 来序列化数据。