那么些项目深入的为大家讲课了pc客户端怎样请求webapi
相信大家在看了自身转发的率先篇小说和那篇作品之后,对webapi再也不会惧怕了!


 

研讨webapi的学识,欢迎加小编微信 
jkxx123321 沟通


 

 

WCF的野心造成了它的急剧复杂,HTTP的一味作育了它的简练精粹。为了促成分布式Web应用,大家不得不将两边凑合在共同
—— WCF服务以HTTP绑定宿主于IIS。

 

于是乎有了令人晕头转向的布局、令人郁闷不已的调节和测试,还有那ServiceContract,
DataContract, EnumMember…还有还有,决不在using语句中调用WCF服务

 

于是时常自问:拿着牛刀削苹果有必不可少吗?废话,当然没有须要,水果刀在哪儿?

 

微软望着这么几人拿着牛刀削苹果,本人也看不下去了,于是,一种水果刀横空出世
—— ASP.NET Web API。

 

前不久我们在实际开发中有个地点用WCF太难为,就小规模试制了一晃水果刀,感觉还不易。

 

下边用2个简单易行的以身作则分享一下ASP.NET Web API水果刀的用法。

 

服务端ASP.NET Web API的实现

 

急需预备的工具:Visual Studio 2008, NuGet

 

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

 

jQuery 1

 

  1. 透过NuGet添加ASP.NET Web
    API的引用,在NuGet中检索时要用“AspNetWebApi”(用“ASP.NET Web
    API”是寻找不到的),然后选用ASP.NET Web API(Beta)进行设置。

 

jQuery 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。代码如下:

 

jQuery 3

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

jQuery 4

 

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

 

jQuery 5

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

jQuery 6

 

6.
给DemoController添加一个措施SiteList,并写上大家的示范代码。代码如下:

 

jQuery 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;
    }
}

jQuery 8

 

  1. 计划一下Web项目的启航设置Specific Page与Specific port

 

jQuery 9

 

  1. Ctrl+F5运行项目,结果如下:

 

jQuery 10

 

jQuery,结果是大家盼望的,用浏览器直接能够查看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:

 

jQuery 11

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

        }
    }
}

jQuery 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的吸引力之一 —— 3次完成,按需服务。

 

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() 完整兑现代码

 

jQuery 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));
    }
}

jQuery 14

 

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

 

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

 

jQuery 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/>');
        });
    }
});

jQuery 16

 

注:上面的代码是可实际运行的啊,代码在演示代码WebApi德姆o项指标AjaxWebApi.htm文件中。那也是ASP.NET
Web API “二次达成,按需服务”的反映。

 

小结 

 

水果刀(ASP.NET Web
API)用下来感觉还行,不仅可以削苹果,还足以削梨子,切西瓜也何足挂齿。用不用牛刀(WCF),还得多着想考虑。

 

相关文章

网站地图xml地图