ASP.NET Web API 入门实战(1)--开篇

最近对之前设备监控项目中所用的ASP.NET Web API技术做了一个小小的总结,写了一个简单的demo,以供师弟师妹们参考。这个系列可以作为ASP.NET Web API的入门实战,demo比较简单,但是我认为对于构建基于ASP.NET Web API的REST风格的服务提供了一个整体的思路,对于入门会有一定的帮助吧。

前言

什么是Web API

Web API是一个比较宽泛的概念,这里我们提到Web API特指ASP.NET Web API。

官方定义如下,强调两个关键点,即可以对接各种客户端(浏览器,移动设备),构建http服务的框架。Web API利用Http协议的各个方面来表达服务(例如 URI/request response header/caching/versioning/content format),因此就省掉很多配置。

利用ASP.NET Web API我们可以很轻松的构建REST风格的服务。

Web API在ASP.NET完整框架中地位如下图:

Web API功能简介

  1. 支持基于Http verb (GET, POST, PUT, DELETE)的CRUD (create, retrieve, update, delete)操作,通过不同的http动作表达不同的含义,这样就不需要暴露多个API来支持这些基本操作。

  2. 请求的回复通过Http Status Code表达不同含义,并且客户端可以通过Accept header来与服务器协商格式,例如你希望服务器返回JSON格式还是XML格式。

  3. 请求的回复格式支持 JSON,XML,并且可以扩展添加其他格式。

  4. 原生支持OData。

  5. 支持Self-host或者IIS host。

  6. 支持大多数MVC功能,例如Routing/Controller/Action Result/Filter/Model Builder/IOC Container/Dependency Injection。

REST风格服务简介

REST表示表述性状态转移,它代表的是运行在HTTP上的一个简单的无状态的架构,每一个唯一URL代表一个资源。在创建RESTful服务时,应遵循四个基本的设计原则:

  1. 使用HTTP方法(动词),使用统一的方式来获取资源(交互的统一接口),即检索资源使用GET,创建资源使用POST, 更新资源使用PUT / PATCH,删除资源使用DELETE。

  2. 与资源的交互是无状态的, 因此由客户端发起的每个请求应当包括HTTP请求的所有参数,上下文信息和所需服务器返回数据数据类型等。

  3. 资源标识应通过URI来定义,简单来说应该是只使用URI来完成服务器与客户端和资源之间的交互。这些URI可以看作一个RESTful服务提供的接口。

  4. 支持JSON或/和XML等多种格式作为数据传输格式。

开发环境

笔者所用的开发环境如下:

  1. 操作系统:Windows 10 ,64位
  2. IDE:Visual Studio 2013
  3. 数据库:SqlServer 2012

各位小伙伴可以根据自己的需求选用不同的IDE和数据库,IDE强烈推荐VS2013以上的版本,以免掉坑。

涉及技术

在我们的实例中用到了:

  1. SQL Server数据库保存数据
  2. Web API提供REST风格的服务
  3. ORM映射采用的是Entity Framework的Code First开发方式
  4. Vue.js解析Wen API返回的数据,对数据的双向绑定也会做一个简单的介绍

创建Web API项目

打开VS,新建项目,创建ASP.NET Web 应用程序,创建相应的解决方案,如下图:

选择模板为Web API,我们可以看到MVCWeb API两项已经默认打勾,


作为简单的 ASP.NET Web API 入门项目,我们在这里先不涉及身份认证,因此,点击右侧的“更改身份认证”,我们选择“无身份认证”,如下图所示:

就这样,一个Web API项目就创建好了,不得不感叹 VS 是宇宙最强大的 IDE ,微软出的东西就是简单易用。

看一下代码结构,是典型的MVC,我们可以看到在Controller文件夹中有两个自动生成的控制器类,供我们参考:

ValuesController.cs中,ValuesController继承了ApiController类,提供了GETPOSTPUTDELETE方法,为了让示例简单化,values值被存储在控制器类中的固定数组中。当然,在实际应用程序中,你可能想要查询数据库或使用其他外部数据源,我们将会在下面的部分进行介绍。代码如下:

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

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

        // POST api/values
        public void Post([FromBody]string value)
        {
        }

        // PUT api/values/5
        public void Put(int id, [FromBody]string value)
        {
        }

        // DELETE api/values/5
        public void Delete(int id)
        {
        }
    }

控制器定义了两个返回value值的方法:

  1. IEnumerable<string> Get()方法将整个列表作为IEnumerable类型返回。
  2. Get(int id)方法通过它的ID来查找单个value值。

没错,你已经有一个可以使用的web API了。控制器上的每个方法都对应一个或多个URI,我们先尝试调用一下Web API,点击启动调试,可以看到项目的主页是基于Boonstrap的。

调用Web API,控制器方法和对应的URI如下:
Controlle Method为:IEnumerable<string> Get()
URI为: api/values

Controlle Method为:string Get(int id)
URI为: api/values/id

调用结果如下图(所用浏览器为Chrome,使用IE核浏览器会提示保存Json文件):
1.调用api/values

2.调用api/values/2

上面调用Web API返回的格式XML格式的,后边的部分我会介绍如何强制返回Json格式。

下面将具体介绍如何创建数据实体并运用Entity Framework与数据库进行交流。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,835评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,598评论 1 295
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,569评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,159评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,533评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,710评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,923评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,674评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,421评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,428评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,114评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2 271

推荐阅读更多精彩内容

  • 本系列主要翻译自《ASP.NET MVC Interview Questions and Answers 》- B...
    圣杰阅读 3,867评论 0 56
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 一说到REST,我想大家的第一反应就是“啊,就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束,以及如...
    时待吾阅读 3,339评论 0 19
  • 前言HTTP不仅仅服务于web页面,同时也是构建暴露服务和数据的API的强大平台。HTTP有着简单、灵活和无处不在...
    极客学院Wiki阅读 2,136评论 1 7
  • Phenomenalism By Tsai Cheng-Yuan Come from life, art shap...
    陈子弘阅读 962评论 2 6