使用ASP.Net WebAPI构建REST服务（一）——简单的示例

川长思鸟来 2022-07-15 23:47 153阅读 0赞

# [使用ASP.Net WebAPI构建REST服务（一）——简单的示例][ASP.Net WebAPI_REST] #

由于给予REST的Web服务非常简单易用，它越来越成为企业后端服务集成的首选方法。本文这里介绍一下如何通过微软的Asp.Net WebAPI快速构建REST-ful 服务。

首先创建一个Asp.Net Web应用程序（我这里用的是Visual Studio 2013，它已经内置了Web API2）。

![021717403921020.png][]

在出来的模板中选择Empty（空项目），并勾选WebAPI。点击确定后，就创建了一个空的WebAPI服务。

![021717456119881.png][]

此时只有一个空项目，还没有任何功能，在进行下一步之前，首先我们来看一下REST的基本操作模型，大致可以分为如下四种：

*  POST — 创建资源 
 *  GET — 检索资源 
 *  PUT — 更新资源 
 *  DELETE — 删除资源

非常经典的CRUD模型。在Web API中实现这样一个的模型是非常简单的，直接使用向导建一个Controller即可

![021717480175582.png][]

![021717500646642.png][]

如果用传统的向导，记得把向导后面的那个1给去掉：

默认的模板内容如下：

publicclass ValuesController :  ApiController  
    \{  
        // GET api/<controller>  
        public IEnumerable<string> Get()  
        \{  
            return newstring\[\] \{ "value1",  "value2" \};  
        \}  
  
        // GET api/<controller>/5  
        public string Get(int id)  
        \{  
            return "value";  
        \}  
  
        // POST api/<controller>  
        public void Post(\[FromBody\]string value)  
        \{  
        \}  
  
        // PUT api/<controller>/5  
        public void Put(int id, \[FromBody\]string value)  
        \{  
        \}  
  
        // DELETE api/<controller>/5  
        public void Delete(int id)  
        \{  
        \}  
    \}

这其实已经帮我们实现了一个最基本的服务了，不过这个服务中只实现了Get，它支持如下两种中方式的URL访问（其它的方式也能访问，但没有具体的效果）：

*  api/values        访问所有的Value列表     
 *  api/values/\{id\}        根据ID访问Value

按Ctrl + F5中执行，在浏览器中输入相应的地址即可看到结果

![021717503306956.png][]

下面我们要做的就是完善它，实现一个简单的查询功能，这里我引用了微软官方的一个例子：

publicclass ProductsController :  ApiController  
\{  
        Product\[\] products = new Product\[\]  
        \{  
            new Product \{ Id = 1, Name =  "Tomato Soup", Category =  "Groceries", Price = 1 \},  
            new Product \{ Id = 2, Name =  "Yo-yo", Category =  "Toys", Price = 3.75M \},  
            new Product \{ Id = 3, Name =  "Hammer", Category =  "Hardware", Price = 16.99M \}  
        \};  
  
        public IEnumerable<Product> Get()  
        \{  
            return products;  
        \}  
  
        public IHttpActionResult Get(int id)  
        \{  
            var product = products.FirstOrDefault((p) => p.Id == id);  
            if (product ==  null)  
            \{  
                return NotFound();  
            \}  
            return Ok(product);  
        \}  
    \}  
  
    public classProduct  
    \{  
        public int Id \{ get; set; \}  
        public string Name \{ get; set; \}  
        public string Category \{ get; set; \}  
        public decimal Price \{ get; set; \}  
    \}

此时，我们就可以在浏览器中看到结果了（由于Controller改名字了，此时的地址就变成了api/products）

![021717505336485.png][]

到此为止，一个基于Asp.net Web API的 简单的REST Web服务就构建完成了，由于篇幅所限，这里就不做更多的介绍了，跟多信息可以参看微软官方文档：[Getting Started with ASP.NET Web API 2][]。另外，如果想对REST有更深入的了解的话，可以看看infoq的这篇文章：[深入浅出REST][REST]。关于Asp.net Web API其它内容，我后续大概还会陆续写几篇文章来介绍它。

分类: [ ASP.Net][ASP.Net]

好文要顶 关注我  收藏该文 ![icon_weibo_24.png][] ![wechat.png][]

[![u12132.png_id_16180817][]][u12132.png_id_16180817 1]

[天方][u12132.png_id_16180817 1]  
[关注 - 0][- 0]  
[粉丝 - 496][- 496]

\+加关注

[« ][Link 1]上一篇： [WPF在代码中创建DataTemplate时候的异常][Link 1]  
[» ][Link 2]下一篇： [使用ASP.Net WebAPI构建REST服务（二）——路由][Link 2]

posted on 2014-05-02 17:18 [ 天方][Link 3] 阅读( 14681) 评论( 0) [ 编辑][Link 4] [ 收藏][Link 5]

[ASP.Net WebAPI_REST]: http://www.cnblogs.com/TianFang/p/3704221.html
[021717403921020.png]: /images/20220716/89a5865d505e43d1ad22e1174519379f.png
[021717456119881.png]: /images/20220716/14be605444dd4f0084952c67f01e4393.png
[021717480175582.png]: /images/20220716/caced078edad4258b452d820ef416db7.png
[021717500646642.png]: /images/20220716/f37ab0a8f3d34604873eafb7700c6ad2.png
[021717503306956.png]: /images/20220716/dfe98eccedb945c489fe111f349604b6.png
[021717505336485.png]: /images/20220716/3c75734f91b840ba9f41cfb116ee00aa.png
[Getting Started with ASP.NET Web API 2]: http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/tutorial-your-first-web-api
[REST]: http://www.infoq.com/cn/articles/rest-introduction
[ASP.Net]: http://www.cnblogs.com/TianFang/category/721007.html
[icon_weibo_24.png]: http://common.cnblogs.com/images/icon_weibo_24.png
[wechat.png]: /images/20220716/d78e48614df14326bf45a5daa1ecdebe.png
[u12132.png_id_16180817]: /images/20220716/4f158b022abe464e96a612f7a1d9bee8.png
[u12132.png_id_16180817 1]: http://home.cnblogs.com/u/TianFang/
[- 0]: http://home.cnblogs.com/u/TianFang/followees
[- 496]: http://home.cnblogs.com/u/TianFang/followers
[Link 1]: http://www.cnblogs.com/TianFang/p/3695326.html
[Link 2]: http://www.cnblogs.com/TianFang/p/3705003.html
[Link 3]: http://www.cnblogs.com/TianFang/
[Link 4]: https://i.cnblogs.com/EditPosts.aspx?postid=3704221
[Link 5]: http://www.cnblogs.com/TianFang/p/3704221.html#