WCF Web API轻松实现REST

开发 前端
WCF Web API 是 “First-class programming model for HTTP in WCF”,而 HTTP 是 Web 世界的通行证,Web API 可以让我们更轻松地畅游于 Web 编程世界。

先体验一下,如果没有 WCF Web API,直接用 WCF 实现 REST 有多麻烦:

1. 创建 WCF 服务(ServiceContract)。

2. 创建 .svc 文件指向该 WCF 服务。

3. 在 web.config 中添加<service>/<endpoint>  配置,并将 binding 设置为 webHttpBinding,示例配置如下:

  1. <services> 
  2.     <service name="CNBlogs.OpenAPI.Service.NewsRestService"> 
  3.     <endpoint binding="webHttpBinding"   
  4.                 contract="CNBlogs.OpenAPI.Service.INewsRestService"   
  5.                 behaviorConfiguration="RESTFul" /> 
  6.     </service> 
  7. </services> 

4. 在 web.config 中添加 <endpointBehaviors>/<behavior> 配置,并在其中添加<webHttp />,在第3步的配置中添加该behaviorConfiguration(比如上面代码中的behaviorConfiguration="RESTFul"),示例配置如下:

  1. <endpointBehaviors> 
  2.     <behavior name="RESTFul"> 
  3.         <webHttp /> 
  4.     </behavior> 
  5. </endpointBehaviors> 

5. 在 OperationContract 方法上增加 WebInvoke 属性,示例代码如下:

  1. [OperationContract]  
  2. [WebInvoke(Method = "GET",  
  3.     UriTemplate = "News/Recent/{itemcount}",  
  4.     ResponseFormat = WebMessageFormat.Xml)  
  5. ]          
  6. IQueryable<NewsItem> GetRecentNews(int itemcount); 

上面的5步已经够麻烦了。开始以为到此就可以收工了,哪知不运行不知道,一运行吓一跳:

  1. Operation 'GetRecentNews' in contract 'INewsRestService' has a path variable named 'itemcount' which does not have type 'string'.    
  2. Variables for UriTemplate path segments must have type 'string'. 

参数竟然不能用int类型,必须要用 string。只能望 WCF 心叹,不得不进入第6步。

6. 将 int 改为 string
 

  1. IQueryable<NewsItem> GetRecentNews(string itemcount); 

这是纯 WCF 实现 REST 的表演节目,节目名称叫“ WCF 实现 REST 六步走”,表演得分6分。

接下来,我们看看 WCF Web API 的表演

(如果不知道 WCF Web API 是何方神圣,请看演员介绍http://wcf.codeplex.com/wikipage?title=WCF%20HTTP)

1. 在提供 REST 服务的方法上增加 [WebGet(UriTemplate = "")] 属性,示例代码如下:

  1. [ServiceContract]  
  2. public class NewsRestService  
  3. {  
  4.     [WebGet(UriTemplate = "{itemcount}")]  
  5.     public IQueryable<NewsItem> GetRecentNews(int itemcount)  
  6.     {   
  7.         return newsList.AsQueryable();  
  8.     }   

2. 在 Global.asax 的 Application_Start 中添加路由,示例代码如下:

  1. protected void Application_Start(object sender, EventArgs e)  
  2. {  
  3.     var config = new HttpConfiguration() ;  
  4.     RouteTable.Routes.Add(new ServiceRoute("news/recent",  
  5.         new HttpServiceHostFactory { Configuration = config },  
  6.         typeof(NewsRestService)));  

注:需要通过 NuGet 添加对 WebApi.All 的引用。news/recent 就是 REST 访问网址。

收工!只需两步就实现 REST,WCF Web API 的表演得分2分。

2 : 6,WCF Web API 大获全胜!(分数少的怎么反而获胜?这是代码世界,不是现实世界,程序员说了算,谁的代码少,谁就获胜)

小结
WCF Web API 是 “First-class programming model for HTTP in WCF”,而 HTTP 是 Web 世界的通行证,Web API 可以让我们更轻松地畅游于 Web 编程世界。

实现 REST 只是 WCF Web API 小试牛刀,我们还可以不用修改任何服务端代码,只改变客户端请求的方式,就可以返回不现类型的数据。
比如:

1)将 HTTP Header 中的 Accept 改为 “application/json”,返回的就是 JSON 数据。

2)通过 Url 参数发起 OData 查询(比如“?$top=4&$orderby=Title” ),服务器收到请求后,会对返回结果进行 LINQ 查询(因此示例代码中的返回值类型是IQueryable<NewsItem>)。

原文:http://www.cnblogs.com/dudu/archive/2011/10/27/wcf_web_api.html

【编辑推荐】

  1. 百度地图API之如何制作公交导航
  2. 走进Windows线程同步API
  3. 谷歌拼音输入法扩展API开发指南
  4. 新浪微博API开发简介之用户授权(PHP基础篇)
  5. 百度地图API开发指南
责任编辑:陈贻新 来源: dudu的博客
相关推荐

2009-11-09 10:35:10

WCF REST服务

2010-10-28 09:56:53

Web APIRESTSOAP

2011-09-23 09:55:15

WCF Web API

2009-05-18 09:21:46

XMLRIAREST

2009-11-06 14:40:34

WCF REST架构

2010-02-25 16:07:28

WCF REST

2022-03-29 09:00:00

Angular框架REST API

2010-02-24 09:18:49

WCF Adapter

2009-07-22 14:50:50

ibmdwWeb2.0Twitter

2024-01-09 09:09:45

RESTGraphQL

2023-01-10 09:48:03

RESTAPIJersey

2009-11-09 15:28:04

WCF知识结构

2009-09-22 11:49:34

ibmdwREST

2014-06-09 15:29:13

OData v4.0

2022-02-10 23:38:23

API架构设计

2011-04-28 09:23:36

REST

2009-07-29 17:45:09

ibmdwWebREST

2009-07-31 16:26:28

ibmdwREST

2009-12-08 18:31:58

WCF WEB

2022-05-06 09:52:17

REST接口API
点赞
收藏

51CTO技术栈公众号