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，我们可以看到MVC和Web API两项已经默认打勾，

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

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

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

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

public class ValuesController : ApiController
    {
        // GET api/values
        public IEnumerable 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 Get()方法将整个列表作为IEnumerable类型返回。
2. Get(int id)方法通过它的ID来查找单个value值。

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

调用Web API，控制器方法和对应的URI如下：
Controlle Method为：IEnumerable 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与数据库进行交流。