ASP.NET MVC Web API 学习笔记---Web API概述及程序示例

时间 2019-11-06

标签 asp.net asp mvc web api 学习笔记概述程序示例栏目 ASP 繁體版

原文原文链接

1. Web API简单说明javascript

近来不少大型的平台都公开了Web API。好比百度地图 Web API，作过地图相关的人都熟悉。公开服务这种方式可使它易于与各类各样的设备和客户端平台集成功能，以及经过在浏览器中使用 JavaScript来建立更丰富的HTML体验。因此我相信Web API会愈来愈有它的用武之地。html

说道Web API不少人都会想到Web服务，可是他们仍然有必定的区别：Web API服务是经过通常的 HTTP公开了，而不是经过更正式的服务合同（如SOAP）java

2. ASP.NET Web API简介jquery

ASP. NET Web API支持让你可以轻松地建立功能强大的 Web API，能够从范围普遍的客户端（包括使用 JavaScript从浏览器中，到任何移动/客户端平台上的本机应用程序）访问。它提供如下支持：编程

(1)现代 HTTP 的编程模型：在你的 Web 应用程序中直接访问和处理 HTTP 请求并响应，使用清洁、强类型的 HTTP 对象模型。除了在服务器上支持这个 HTTP 的编程模型以外，经过使用新的 HttpClient API来从任何.NET 应用程序中调用 Web ApI，咱们也支持客户端中相同的编程模型。json

(2)内容协商： Web API 有对内容协商的内置支持 — — 这使客户端和服务器一块儿工做以决定从一个 API 返回的正确的数据格式。咱们为JSON、 XML 和Form URL 编码的格式提供默认支持，并能够经过添加你本身的格式化程序来扩展这种支持，或者甚至用你本身的来替换默认的内容协商策略。api

(3)查询组成： Web API 经过 OData URL 公约使你可以轻松地支持查询。当你从你的 Web API 返回一种类型的 IQueryable <T> 时，框架将自动为它提供 OData 查询支持—— 使其易于分页和排序。浏览器

(4)模型绑定和验证：模型绑定器提供了一种简单的方法来从HTTP 请求中的不一样部分提取数据，并将这些信息部分转换为Web API行为可以使用的.NET对象。Web API 支持相同的模型绑定和ASP. NET MVC 现今支持的验证基础结构。服务器

(5)路由： Web ApI 支持完整的路由功能集。现今ASP. NET MVC 和 ASP.NET也支持这一点，包括路线参数和约束。默认状况下，Web API 还提供了智能公约，使你可以轻松地建立实现 Web ApI的类，而无需不得不将属性应用到你的类或方法中。Web API 的配置纯粹是经过代码来实现的 — — 保持你的配置文件干净。架构

(6)筛选器： Web ApI 使你可以轻松地使用和建立筛选器（例如： [受权]），那样你可以封装和应用交叉行为。

(7)改进的可测试性：与其在静态文本对象中设置 HTTP 的详细信息，不如将 Web API 行为与 HttpRequestMessage 和 HttpResponseMessage 一块儿使用— — 两个新的HTTP对象（在其余内）使测试更容易。例如，你能够单元测试你的 Web ApI，而无需不得不使用 Mocking 框架。

(8)IoC支持： Web API 支持由 ASP. NET MVC 实现的服务定位器模式，使你可以解决不一样设备的依赖。你能够轻松地使用IoC容器或依赖注射架构来集成，以保持干净的依赖解决方案。

(9)灵活的托管： Web ApI能够托管在任何类型的 ASP.NET应用程序内（包括这两个基于应用程序的ASP. NET MVC和ASP.NET Web Forms）。咱们还设计了 Web API 支持，这样，你还能够选择在你本身的进程内托管/公开它们，若是你不想使用 ASP.NET/IIS 来这样作。至于你如何以及在哪儿使用它，这给了你最大的灵活性。

3. 建立一个Web API程序

启动VS2012建立一个新项目，在已经安装的模板中选择 ASP.NET MVC4 Web API程序

在ASP.NET MVC项目对话框中选择Web API项，点击肯定

建立成功以后工程中会自动添加一个Web API服务控制器，上面并附带访问地址

项目解决方案，选择Models文件夹右键添加一个Model类

代码以下：

namespace Git.Framework.WebAPI.Models

    public class Contact

        public int ID { get; set; }

        public string Name { get; set; }

        public string Sex { get; set; }

        public DateTime Birthday { get; set; }

        public int Age { get; set; }

工程解决方案选择Controllers文件夹右键添加一个新的Web API controller

在添加控制器弹出对话框中选择模板：空API控制器

控制器中添加以下代码：

namespace Git.Framework.WebAPI.Controllers

    public class ContactController : ApiController

        Contact[] contacts = new Contact[]

            new Contact(){ ID=1, Age=23, Birthday=Convert.ToDateTime("1977-05-30"), Name="情缘", Sex="男"},

            new Contact(){ ID=2, Age=55, Birthday=Convert.ToDateTime("1937-05-30"), Name="令狐冲", Sex="男"},

            new Contact(){ ID=3, Age=12, Birthday=Convert.ToDateTime("1987-05-30"), Name="郭靖", Sex="男"},

            new Contact(){ ID=4, Age=18, Birthday=Convert.ToDateTime("1997-05-30"), Name="黄蓉", Sex="女"},

};

        /// <summary>

        /// /api/Contact

        /// </summary>

        /// <returns></returns>

        public IEnumerable<Contact> GetListAll()

            return contacts;

        /// <summary>

        /// /api/Contact/id

        /// </summary>

        /// <param name="id"></param>

        /// <returns></returns>

        public Contact GetContactByID(int id)

            Contact contact = contacts.FirstOrDefault<Contact>(item=>item.ID==id);

            if (contact == null)

                throw new HttpResponseException(HttpStatusCode.NotFound);

            return contact;

        /// <summary>

        /// 根据性别查询

        /// /api/Contact?sex=女

        /// </summary>

        /// <param name="sex"></param>

        /// <returns></returns>

        public IEnumerable<Contact> GetListBySex(string sex)

            return contacts.Where(item => item.Sex == sex);

4. 浏览器访问API路径

Controller Methed	URI
GetListAll	/api/Contact
GetListBySex	"/api/Contact?sex=" + sex
GetContactByID	/api/Contact/"+id

在IE浏览器中浏览出现以下效果

若是在Chrome 或者 FireFox 中浏览会先下以下效果

5. Javascript访问Web API

在项目中添加一个About View视图

代码以下：

@{

    Layout = null;

<!DOCTYPE html>

<html>

<head>

    <meta name="viewport" content="width=device-width" />

    <title>About</title>

    <script type="text/javascript" src="/Scripts/jquery-1.7.1.min.js"></script>

    <script type="text/ecmascript">

        $(document).ready(function () {

            $("#btnAll").click(function () {

                $.getJSON("/api/Contact", function (data) {

                    var html = "<ul>";

                    $(data).each(function (i, item) {

                        html += "<li>"+item.ID+":"+item.Name+":"+item.Sex+"</li>";

});

                    html += "</ul>";

                    $("#contactAll").html(html);

});

});

            $("#btnID").click(function () {

                var id = $("#txtID").val();

                $.getJSON("/api/Contact/"+id, function (data) {

                    var html = "<ul>";

                    $(data).each(function (i, item) {

                        html += "<li>" + item.ID + ":" + item.Name + ":" + item.Sex + "</li>";

});

                    html += "</ul>";

                    $("#contactID").html(html);

});

});

            $("#btnSex").click(function () {

                var sex = $("#ddlSex").val();

                $.getJSON("/api/Contact?sex=" + sex, function (data) {

                    var html = "<ul>";

                    $(data).each(function (i, item) {

                        html += "<li>" + item.ID + ":" + item.Name + ":" + item.Sex + "</li>";

});

                    html += "</ul>";

                    $("#contactSex").html(html);

});

});

});

    </script>

</head>

<body>

<p>

        <input type="button" id="btnAll" value="查询全部" />&nbsp;

    </p>

<p>

        <input type="text"  id="txtID" name="txtID"/>

        <input type="button" id="btnID" value="根据ID查询" />&nbsp;

    </p>

<p>

        <select id="ddlSex" name="ddlSex">

            <option value="男">男</option>

            <option value="女">女</option>

        </select>

        <input type="button" id="btnSex" value="根据性别查询" />&nbsp;

    </p>

    <div id="contactAll">

    </div>

    <div id="contactID">

    </div>

    <div id="contactSex">

    </div>

</body>

</html>

运行结果效果图

6. Web API总结

1.Web API 控制器(Controller) 继承ApiController

2. Api 的 Url Map： api/{controller}/{id} 每一个"Action"是经过 Http谓词(GET/POST/PUT/DELETE)映射的

3.客户端能够经过 Http Header 的 Accept 指定返回数据的格式。默认是支持：appliction/xml 和 application/json，当想返回好比 image/jpeg 这样的图片格式时，须要添加 MediaTypeFormatter 。好比：当指定某个 Task 时，经过指定 Accept : image/jpeg 获取该 Task 的图片信息。(后面详细介绍)