web api初学

据说web api的作用和wcf的一样,只是比wcf更简单而已,具体如何我也不清楚,毕竟不是做学术研究的,我只是通过简单的例子来学习web api。能做的只需要知其然,不必管其所以然。当然有兴趣的可以去研究。

1、VS2013建立一个asp.net MVC4 web的应用程序

可以看到这个项目比一般的MVC项目多了几个文件夹,最主要的是控制器里面多了一个Values控制器,而且没有相应的视图。这也是与MVC的不同,主要是没有视图。这个Values控制器继承的是ApiController而不是Controller,这也是一个不同的地方

2、看看webapiconfig文件,这里设置了api的访问路由

3、WCF主要提供一个对数据增删改查的服务,那么作为它的瘦身版的web api也是如此。首先来看看这个Values控制器,系统自动提供了几个函数,首先看看两个GET函数,只是用于查询数据的。

// GET api/values
        public IEnumerable<string> Get()
        {
            return new string[] { "value1", "value2" };
        }

        // GET api/values/5
        public string Get(int id)
        {
            return "value";
        }

运行程序,在地址栏后面加上/api/values,可以看到程序返回的数据。至于为什么是xml格式的数据,这里就不讨论了,只需要知道我通过一个url就能访问Values控制器中get函数返回的数据。但是有两个get函数,为什么调用的是第一个。那是因为url能匹配的路由是DefaultApi,而且url中没有提供参数,所以就调用了第一个get函数。如果在地址栏后面加上/api/values/5的话,就能调用有参的get函数了。

控制器里面还有其他的函数,为什么这里要调用get函数而不是其他的。那是因为,在api中,所有用get方式请求的函数,都必须以get开头,否则就会报错:请求的资源不支持 http 方法“GET”。如果吧这两个get函数改一下名称,不以get开头,那么同样的url就没法访问数据了。但是不可能让所有的函数都以get开头吧,解决的方法就是对函数添加[HttpGet]约束,这样就可以用原来的url访问到数据了。那么问题又来了,如果有多个[HttpGet]修饰的无参函数,仍然以上面的url来访问,这时候又得报错了,因为系统发现可调用的函数不唯一,不知道该调用谁。这个时候我们就需要配置路由,定义更精确的url来访问函数了

4、webapiconfig文件,然后对values控制器的get函数修改下。

运行程序

5、web api是简单版的wcf,而wcf在完成后,是需要发布到服务器上,在使用的时候需要通过引入服务才能使用,而且还需要配置终结点。api也同样需要发布到服务器上,但是在用的时候只需要通过网址就能使用了,不需要去添加引用,配置复杂的终结点。下面就通过例子来看看如何在其他项目上调用web api

6、在解决方案中添加一个类库项目,用这个类库项目来模拟数据库。在项目中添加如下两个类,用来模拟数据源

public class SiteSource
    {
        public IList<Site> DateSource()
        {
            List<Site> 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" });
            return sites;
        }
    }

    public class Site
    {
        public int SiteId { get; set; }
        public string Title { get; set; }
        public string Uri { get; set; }
    }

在values控制器中添加如下函数

 /// <summary>
        /// 查询指定位置开始指定数量的数据
        /// </summary>
        /// <param name="index"></param>
        /// <param name="num"></param>
        /// <returns></returns>
        [HttpGet]
        public IEnumerable<Site> SearchSites(int index,int num)
        {
            SiteSource s = new SiteSource();
            return s.DateSource().Skip(index).Take(num).ToList();
        }

     /// <summary>
     /// 根据title来查询
     /// </summary>
     /// <param name="t"></param>
     /// <returns></returns>
        [HttpGet]
        public Site SearchSites(string t)
        {
            SiteSource s = new SiteSource();
            Site sit= s.DateSource().Where(o => o.Title == t).Single();
            return sit;
        }

7、在解决方案中再建一个MVC项目,通过这个项目来调用webapi实现数据的增删改查。建立好必要的控制器和视图,这里的控制器最好不要命名为home,因为它与webapi项目中的控制器同名了,这会导致待会在运行的时候报错。下面分别是控制器和视图中的代码

public class WebController : Controller
    {
        //
        // GET: /WebApi/

        public ActionResult Index()
        {
            IList<Site> s = getObjByTitle();
            return View(s);
        }

        private IList<Site> getObjByTitle()
        {
            HttpClient httpClient = new HttpClient();
            //GET方式去调用webapi
            var responseJson = httpClient.GetAsync("http://localhost:6972/api/values/SearchSites?t=test")
                .Result.Content.ReadAsStringAsync().Result;

        Site site = JsonConvert.DeserializeObject<Site>(responseJson);
        IList<Site> sites = new List<Site>();
        sites.Add(site);

       return sites;
        }

    }
@using Model;
@model IList<Site>
@{
    ViewBag.Title = "Index";
}

<h2>Index</h2>
@{
    foreach (Site s in Model)
    {
        <h2>@s.Title</h2>
        <h3>@s.Uri</h3>
    }
}

8、准备运行程序,这个时候需要同时运行两个项目,除了类库以外的两个项目,在解决方案上右键,选择属性

运行,结果:

可以看到网页上出现了我想要的效果,调用是成功的。

与wcf比,webapi的优势是很明显的,首先一个,在调用的时候就不需要在项目中添加服务引用,直接一个网址搞定。其次,因为没有添加引用,项目和webapi就完全没有任何关联,也就是解耦了,那个网址,说白了就是个字符串,完全可以写到配置文件中去。然后,webapi的测试也很方便,只需要一个网址就可以测试,当然这里肯定涉及到了访问的安全机制,这不是本文讨论的范围。

还有几个疑问,webapi的访问方式有哪几种,如何实现数据的增删改,上面通过api获得的数据为什么是json格式,还能有其他格式吗。这些下回再讨论。

时间: 2024-10-11 03:25:49

web api初学的相关文章

C# web api 返回类型设置为json的两种方法

每次写博客,第一句话都是这样的:程序员很苦逼,除了会写程序,还得会写博客!当然,希望将来的一天,某位老板看到此博客,给你的程序员职工加点薪资吧!因为程序员的世界除了苦逼就是沉默.我眼中的程序员大多都不爱说话,默默承受着编程的巨大压力,除了技术上的交流外,他们不愿意也不擅长和别人交流,更不乐意任何人走进他们的内心! 悟出来一个道理,在这儿分享给大家:学历代表你的过去,能力代表你的现在,学习代表你的将来.我们都知道计算机技术发展日新月异,速度惊人的快,你我稍不留神,就会被慢慢淘汰!因此:每日不间断的

Asp.Net MVC及Web API框架配置会碰到的几个问题及解决方案 (精髓)

前言 刚开始创建MVC与Web API的混合项目时,碰到好多问题,今天拿出来跟大家一起分享下.有朋友私信我问项目的分层及文件夹结构在我的第一篇博客中没说清楚,那么接下来我就准备从这些文件怎么分文件夹说起.问题大概有以下几点: 1.项目层的文件夹结构 2.解决MVC的Controller和Web API的Controller类名不能相同的问题 3.给MVC不同命名空间的Area的注册不同的路由 4.让Web API路由配置也支持命名空间参数 5.MVC及Web API添加身份验证及错误处理的过滤器

C#开发微信门户及应用(47) - 整合Web API、微信后台管理及前端微信小程序的应用方案

在微信开发中,我一直强调需要建立一个比较统一的Web API接口体系,以便实现数据的集中化,这样我们在常规的Web业务系统,Winform业务系统.微信应用.微信小程序.APP等方面,都可以直接调用基于JSON数据格式的Web API接口,在我之前的几篇随笔中,对这方面都有一定的介绍,本篇继续这个主题,细致深入的阐述如何在接口和源码的基础上整合Web API.微信后台管理及前端微信小程序的应用方案. 1.基于Web API的微信开发框架 首先我们各个业务模块,都应该围绕着Web API进行展开,

微信小程序的Web API接口设计及常见接口实现

微信小程序给我们提供了一个很好的开发平台,可以用于展现各种数据和实现丰富的功能,通过小程序的请求Web API 平台获取JSON数据后,可以在小程序界面上进行数据的动态展示.在数据的关键 一环中,我们设计和编写Web API平台是非常重要的,通过这个我们可以实现数据的集中控制和管理,本篇随笔介绍基于Asp.NET MVC的Web API接口层的设计和常见接口代码的展示,以便展示我们常规Web API接口层的接口代码设计.参数的处理等内容. 1.Web API整体性的架构设计 我们整体性的架构设计

Entity Framework 6 Recipes 2nd Edition(9-3)译-&gt;找出Web API中发生了什么变化

9-3. 找出Web API中发生了什么变化 问题 想通过基于REST的Web API服务对数据库进行插入,删除和修改对象图,而不必为每个实体类编写单独的更新方法. 此外, 用EF6的Code Frist实现数据访问管理. 本例,我们模拟一个N层场景,用单独的客户端(控制台应用)来调用单独的基于REST服务的Web网站(WEB API应用) . 注意:每层使用单独的Visual Studio 解决方案, 这样更方便配置.调试和模拟一个N层应用. 假设有一个如Figure 9-3所示的旅行社和预订

ASP.NET Web API 2基于令牌的身份验证

基于令牌的认证 我们知道WEB网站的身份验证一般通过session或者cookie完成的,登录成功后客户端发送的任何请求都带上cookie,服务端根据客户端发送来的cookie来识别用户. WEB API使用这样的方法不是很适合,于是就有了基于令牌的认证,使用令牌认证有几个好处:可扩展性.松散耦合.移动终端调用比较简单等等,别人都用上了,你还有理由不用吗? 下面我们花个20分钟的时间来实现一个简单的WEB API token认证: Step 1: 新建一个空的WEB API项目,项目名称就设置为

2种方式解决nginx负载下的Web API站点里swagger无法使用

Web API接口站点,引入了swagger来实时生成在线的api文档,也便于api接口的在线测试.swagger:The World's Most Popular Framework for APIs. 本地测试没有问题. 发布到生产,问题出现了.——线上部署的站点是用nginx做的3个节点的负载.nginx配置了公开的域名,并且与3个节点iis上的站点做了映射.3个单节点的端口不是默认的80,由此问题产生了:当访问swagger时,swagger自动获取的文档的url包含了这个端口,因为站点

asp.net core 2.0 web api基于JWT自定义策略授权

JWT(json web token)是一种基于json的身份验证机制,流程如下: 通过登录,来获取Token,再在之后每次请求的Header中追加Authorization为Token的凭据,服务端验证通过即可能获取想要访问的资源.关于JWT的技术,可参考网络上文章,这里不作详细说明, 这篇博文,主要说明在asp.net core 2.0中,基于jwt的web api的权限设置,即在asp.net core中怎么用JWT,再次就是不同用户或角色因为权限问题,即使援用Token,也不能访问不该访

Web Api和Asp.Net mvc post请求区别

这是mvc的,mvc的post请求可以这样写参数,但是web api的不行.而且content_type:"application/json" 必须要写 下面这是web api的:content_type:"application/json" 必须要写