本条项目深入的为大家讲课了pc客户端如何请求webapi
相信我们在看了自家转发的率先篇文章和那篇文章之后,对webapi再也不会惧怕了!


 

座谈webapi的学问,欢迎加小编微信 
jkxx123321 交换


 

 

WCF的野心造成了它的庞然大物复杂,HTTP的只是作育了它的回顾美貌。为了贯彻分布式Web应用,我们只能将两者凑合在一块
—— WCF服务以HTTP绑定宿主于IIS。

 

于是有了令人晕头转向的铺排、令人郁闷不已的调节,还有那ServiceContract,
DataContract, EnumMember…还有还有,永不在using语句中调用WCF服务

 

于是乎时常自问:拿着牛刀削苹果有要求吗?废话,当然没有须要,水果刀在何地?

 

微软瞧着那样多个人拿着牛刀削苹果,本人也看不下去了,于是,一种水果刀横空出世—— ASP.NET Web API。

 

近年来大家在事实上支出中有个地点用WCF太辛劳,就小规模试制了一晃水果刀,感觉还不易。

 

下边用叁个总结的示范分享一下ASP.NET Web API水果刀的用法。

 

服务端ASP.NET Web API的实现

 

内需预备的工具:Visual Studio 二零一零, NuGet

 

  1. 新建叁个空的ASP.NET Web Application项目。

 

json 1

 

  1. 经过NuGet添加ASP.NET Web
    API的引用,在NuGet中追寻时要用“AspNetWebApi”(用“ASP.NET Web
    API”是寻找不到的),然后选择ASP.NET Web API(Beta)举办安装。

 

json 2

 

  1. 添加Global.asax,在Application_Start中注册Web
    API的路由,在Global.asax.cs中添加如下代码:

 

protected void Application_Start(object sender, EventArgs e)
{
    RouteTable.Routes.MapHttpRoute("WebApi", "api/{controller}/{action}/{id}", 
        new { id = RouteParameter.Optional });
}

 

4.
添加Controllers文件夹,在里头添加类文件德姆oController.cs,并让德姆oController继承自ApiController。代码如下:

 

json 3

namespace CNBlogsWebApiDemo.Controllers
{
    public class DemoController : ApiController
    {
    }
}

json 4

 

  1. 添加ViewModels文件夹,在当中添加Site.cs,并定义Site。

 

json 5

namespace CNBlogsWebApiDemo.ViewModels
{
    public class Site
    {
        public int SiteId { get; set; }
        public string Title { get; set; }
        public string Uri { get; set; }
    }
}

json 6

 

6.
给德姆oController添加二个格局SiteList,并写上大家的言传身教代码。代码如下:

 

json 7

public class DemoController : ApiController
{
    public IList<Site> SiteList(int startId, int itemcount)
    {
        var sites = new List<Site>();
        sites.Add(new Site { SiteId = 1, Title = "test", Uri = "www.cnblogs.cc" });
        sites.Add(new Site { SiteId = 2, Title = "博客园首页", Uri = "www.cnblogs.com" });
        sites.Add(new Site { SiteId = 3, Title = "博问", Uri = "q.cnblogs.com" });
        sites.Add(new Site { SiteId = 4, Title = "新闻", Uri = "news.cnblogs.com" });
        sites.Add(new Site { SiteId = 5, Title = "招聘", Uri = "job.cnblogs.com" });

        var result = (from Site site in sites
                        where site.SiteId > startId
                        select site)
                        .Take(itemcount)
                        .ToList();
        return result;
    }
}

json 8

 

  1. 陈设一下Web项指标起步设置Specific Page与Specific port

 

json 9

 

  1. json,Ctrl+F5周转品种,结果如下:

 

json 10

 

结果是大家期望的,用浏览器直接能够查看Web
API的周转结果,测试时会很便宜。

 

好了,服务端Web API就那样轻松化解了!

 

客户端通过HttpClient调用服务端Web API

 

  1. 新建二个WebApiTest的类库项目。

 

  1. 在NuGet中添加System.Net.Http(HttpClient就在那边), Json.NET,
    xUnit.net。

 

  1. 添加类文件WebApiClientTest.cs,添加测试方法WebApi_SiteList_Test:

 

json 11

namespace WebApiClientTest
{
    public class WebApiClientTest
    {
        [Fact]
        public void WebApi_SiteList_Test()
        {

        }
    }
}

json 12

 

4. WebApi_SiteList_Test() 的代码达成

 

4.1 首先,要规定八个东西:

 

  a) 客户端调用WebAPI的方法是Http Get,还Http Post,大家那里采用Http
Post;

 

  b) 客户端调用WebAPI时传递的参数格式,大家那里接纳的是Json。

 

  c) WebAPI再次来到的数据格式,我们那边接纳的也是Json(那也是事先添加Json.NET引用的来头)。

 

4.2 用到的类

 

  • System.Net.Http.HttpClient
  • System.Net.Http.httpContent
  • System.Net.Http.StringContent
  • System.Net.Http.Headers.MediaTypeHeaderValue
  • Newtonsoft.Json.JsonConvert

 

4.3 准备须要传递给WebAPI的参数

 

  要求传递的多少个参数是startId
,itemcount,传递的格式是Json。那里可不曾Javascript中的JSON.stringify(),但我们有Json.NET,再拉长匿名类型,有点用js的感觉,代码如下:

 

var requestJson = JsonConvert.SerializeObject(new { startId = 1, itemcount = 3 });

 

  代码的运作结果:{“startId”:1,”itemcount”:3}

 

  然后用System.Net.Http.StringContent把它打个包:

 

HttpContent httpContent = new StringContent(requestJson);

 

  然后设置一下ContentType:

 

httpContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");

 

4.4 通过Http Post调用WebAPI得到重临结果

 

  HttpClient闪亮登场,调用它的PostAsync()方法轻松消除:

 

var httpClient = new HttpClient();
var responseJson = httpClient.PostAsync("http://localhost:9000/api/demo/sitelist", httpContent)
    .Result.Content.ReadAsStringAsync().Result;

 

  看一下responseJson的结果:

 

[{"SiteId":2,"Title":"博客园首页","Uri":"www.cnblogs.com"},{"SiteId":3,"Title":"博问","Uri":"q.cnblogs.com"},{"SiteId":4,"Title":"新闻","Uri":"news.cnblogs.com"}]

 

  正宗的Json!你注意到没有,服务端WebAPI的代码未作其余改动,我们只是在Http
Headers中校ContentType设置为了application/json,重临的正是Json格式的多少。而笔者辈经过浏览器访问,获得的仍旧标准的XML。那里正是ASP.NET
Web API的魔力之一 —— 二遍达成,按需服务。

 

4.5 将Json格式重回的结果反系列化为强类型

 

  Json.NET又登场:

 

var sites = JsonConvert.DeserializeObject<IList<Site>>(responseJson);

 

  展现一下回来结果:

 

  代码

 

sites.ToList().ForEach(x => Console.WriteLine(x.Title + ":" + x.Uri));

 

  结果  

 

  博客园首页:www.cnblogs.com
  博问:q.cnblogs.com
  新闻:news.cnblogs.com

 

4.6 WebApi_SiteList_Test() 完整兑现代码

 

json 13

public class WebApiClientTest
{
    [Fact]
    public void WebApi_SiteList_Test()
    {            
        var requestJson = JsonConvert.SerializeObject(new { startId = 1, itemcount = 3 });

        HttpContent httpContent = new StringContent(requestJson);
        httpContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");

        var httpClient = new HttpClient();
        var responseJson = httpClient.PostAsync("http://localhost:9000/api/demo/sitelist", httpContent)
            .Result.Content.ReadAsStringAsync().Result;

        var sites = JsonConvert.DeserializeObject<IList<Site>>(responseJson);

        sites.ToList().ForEach(x => Console.WriteLine(x.Title + ":" + x.Uri));
    }
}

json 14

 

注:运维那里的代码在此以前,要先运维WebAPI项目,先把服务跑起来,客户端才能享用到劳动。

 

与jQuery ajax调用代码比较一下:

 

json 15

var requestJson = JSON.stringify({ startId: 1, itemcount: 3 });
$.ajax({
    url: '/api/demo/sitelist',
    data: requestJson,
    type: "post",
    dataType: "json",
    contentType: "application/json; charset=utf8",
    success: function (data) {
        jQuery.each(data, function (i, val) {
            $("#result").append(val.Title + ': ' + val.Uri +'<br/>');
        });
    }
});

json 16

 

注:上边的代码是可真正运营的啊,代码在示范代码WebApi德姆o项指标AjaxWebApi.htm文件中。那也是ASP.NET
Web API “一回达成,按需服务”的彰显。

 

小结 

 

水果刀(ASP.NET Web
API)用下来感觉还不易,不仅能够削苹果,还足以削梨子,切西瓜也不屑一提。用不用牛刀(WCF),还得多考虑考虑。

 

相关文章

网站地图xml地图