WebApi系列~基于RESTful标准的Web Api
微软的web api是在vs2012上的mvc4项目绑定发行的，它提出的web api是完全基于RESTful标准的，完全不同于之前的（同是SOAP协议的）wcf和webService，它是简单，代码可读性强的，上手快的，如果要拿它和web服务相比，我会说，它的接口更标准，更清晰，没有混乱的方法名称，有的只有几种标准的请求，如get,post,put,delete等，它们分别对应的几个操作，下面讲一下：
GET：生到数据列表（默认），或者得到一条实体数据
POST：添加服务端添加一条记录，记录实体为Form对象
PUT：添加或修改服务端的一条记录，记录实体的Form对象，记录主键以GET方式进行传输
DELETE：删除 服务端的一条记录
注意上面公开的API接口都是在XMLHttpRequest情况下调用的，当然你可以使用jquery的ajax组件来完成这个请求调用，它的代码更加面向对象，下面举例说明一下
这是页面的HTML代码部分，实现最基本的CRUD操作
<fieldset>
<legend>测试Web Api
</legend>
<a href="javascript:add()">添加(post)</a>
<a href="javascript:update(1)">更新(put)</a>
<a href="javascript:deletes(1)">删除(delete)</a>
<a href="/api/test">列表(Get)</a>
<a href="/api/test/1">实体(Get)</a>
</fieldset>
<script>
function add() {
$.ajax({
url : "/api/Test/",
type : "POST",
data :{"UserID":4,"UserName":"test","UserEmail":"[email protected]"},
success: function (data) { alert(JSON.stringify(data)); }
});
}
//更新
function update(id) {
$.ajax({
url : "/api/Test?id="+id,
type : "Put",
data :{"UserID":1,"UserName":"moditest","UserEmail":"[email protected]"},
success: function (data) { alert(JSON.stringify(data)); }
});
}
function deletes(id) {
$.ajax({
url : "/api/Test/1",
type : "DELETE",
success: function (data) { alert(data);}
});
}
</script>
下面是ApiController部分的代码：
/// <summary> /// Test模块API /// URI：/Api/Test /// </summary> public class TestController : ApiController { /// <summary> /// User Data List /// </summary> private readonly List<Users> _userList = new List<Users> { new Users {UserID = 1, UserName = "zzl", UserEmail = "[email protected]"}, new Users {UserID = 2, UserName = "Spiderman", UserEmail = "[email protected]"}, new Users {UserID = 3, UserName = "Batman", UserEmail = "[email protected]"} }; /// <summary> /// 得到列表对象 /// </summary> /// <returns></returns> public IEnumerable<Users> Get() { return _userList; } /// <summary> /// 得到一个实体，根据主键 /// </summary> /// <param name="id"></param> /// <returns></returns> public Users Get(int id) { return _userList.FirstOrDefault(i => i.UserID == id); } /// <summary> /// 添加 /// </summary> /// <param name="form">表单对象，它是唯一的</param> /// <returns></returns> public Users Post([FromBody] Users entity) { _userList.Add(entity); return entity; } /// <summary> /// 更新 /// </summary> /// <param name="id">主键</param> /// <param name="form">表单对象，它是唯一的</param> /// <returns></returns> public Users Put(int id, [FromBody]Users entity) { var user = _userList.FirstOrDefault(i => i.UserID == id); if (user != null) { user.UserName = entity.UserName; user.UserEmail = entity.UserEmail; } return user; } /// <summary> /// 删除 /// </summary> /// <param name="id">主键</param> /// <returns></returns> public void Delete(int id) { _userList.Remove(_userList.FirstOrDefault(i=>i.UserID==id)); } }
下面我们看一下各个操作调用的结果：
添加操作（POST）
更新操作（PUT）
最后，再强调一下，web api使用RESTful架构的，不像传统的（同是SOAP的） RPC方式的wcf和web Service，它强调的是接口模块的概念，每个模块都是独立的，每个模块的接口方法都是统一的和单一的，即CRUD方法组成。
感谢您的阅读！