重温ASP.NET WebAPI(一)初阶

前言

本文为个人对WebApi的回顾无参考价值。主要简单介绍WEB api和webapi项目的基本结构,并创建简单地webaapi项目实现CRUD操作。

在商业应用领域中,应用之间的关联是相当重要的,应用之间如移动应用或者单页应用的创建,都需要强大的后端服务提供相应的数据以便进行CRUD操作。

WCF and WebApi 的不同

WCF是基于SOAP协议,支持多种传输协议,多种编码,寄宿于.net framework下,需要生产WSDL代理类文件,更安全可靠。

WebApi是基于HTTP协议,支持XML和json,开源可独立出.net framework。REST风格更适合。


WCF


ASP.NET Web API


支持多种传输协议(HTTP, TCP, UDP和自定义传输协议),允许在协议之间进行切换


只支持HTTP协议。比较适合传输来自各种浏览器、移动应用。


支持多种编码格式(Text, MTOM, Binary),允许相互切换。


支持各种媒体类型,如XML和JSON


符合Web服务标准(可靠的数据,传输,和数据安全)


不支持高标准的协议,如数据可靠性或者传输准确性。基于基本的协议和排版,如HTTP, WebSockets, SSL, JQuery, JSON, XML


支持请求回复、单线和多重消息交换模式


支持HTTP的请求响应模式,但也支持扩展的,如SignalR和WebSocket的整合


基于SOAP协议,因此需要被描述为WSDL,允许自动化工具生成客户端代理,即使服务含有复杂的模式


支持多种方式描述API。从自动生成HTML帮助页面描述,到使用结构metadata整合ODATA到APIs中等等。


寄宿于.net framework


寄宿于.net framework但是开源,也能够独立的下载

使用WCF创建可靠,安全的web服务,可以支持多种传输协议。使用WebAPI创建基于http协议的服务,服务更广的用户群。当创建和设计新的基于REST风格的服务是,采用webapi。虽然WCF也提供支持写REST风格的服务,但是Webapi的支持更好。

SOAP 和 ASP.NET  Web 服务

SOAP是基于标准XML的协议,能够与HTTP通讯。可以理解为程序之间通过以XML为格式的SOAP协议进行通讯。ASP.NET Web服务提供创建SOAP协议的web服务。

SOAP的问题

  1. 元数据metadata也会被传输,占用传输空间。
  2. 需要在客户端创建代理类。当服务端更新服务,客户端也要及时更新代理类。

REST

REST协议用于分布式环境的数据传输,它使我们能够将分布式服务当做一种资源,并通过简单的HTTP协议来操作这些资源。

REST对应数据库CRUD操作的方式,分为4种:

  1. GET:相当于CRUD操作中的R,数据获取
  2. PUT:相当于CRUD操作中的U,数据更改
  3. POST:相当于CRUD操作中的C,数据创建
  4. DELETE:相当于CRUD操作中的D,数据删除

举例说明

当站点为:www.cnblogs.com/blogs, 则代表获取博客列表数据

当站点为www.cnblogs.com/blogs/1,则取决于type类型,如果是put,则创建新的BLOG。

如果是post,则更新当前blog。如果是delete,则删除当前blog。

REST与SOAP对比

  1. 只有使用的数据被传输,而没有元数据。
  2. 省略了代理的创建。

WCF REST服务

WCF比web服务要晚出来。它提供更安全和成熟的方式去创建服务。通过WCF,我们可以定义自己的服务,并配置相关的协议如HTTP,TCP或者IPC甚至消息队列。WCF也可以创建REST服务。

WCF创建REST服务,需要我们做大量的配置工作。通常WCF适用于一些特殊场景,如单向消息传输,消息队列,双工通信。但是使用WCF创建REST服务过于复杂,而且局限于.net 3.5 framework。

ASP.NET Web API介绍

微软提出ASP.NET Web API可以理解为一个框架,用于快速简易的创建REST服务。

Web API的入门创建

我们可以点开Values的controller,它集成ApiController,实现的一般的Get,Post,Put,Delete的功能。并提供了响应的URL路径说明。

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)
        {
        }
    }

打开App_Start文件下的RouteConfig.cs文件,可以看到完整的api路由设置。

public class RouteConfig
    {
        public static void RegisterRoutes(RouteCollection routes)
        {
            routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

            routes.MapRoute(
                name: "Default",
                url: "{controller}/{action}/{id}",
                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
            );
        }
    }

实现自己的webapi

public class UserController : ApiController
    {
        public IHttpActionResult GetRead()
        {
            var employeeListViewModel = new EmployeeListViewModel();

            var empBal = new EmployeeBusinessLayer();
            var employees =  empBal.GetEmployees();

            var empViewModels = employees.Select(emp => new EmployeeViewModel
            {
                Name = emp.Name,
                Salary = emp.Salary.ToString(),
                SalaryColor = emp.Salary > 15000 ? "yellow" : "green"
            }).ToList();

            employeeListViewModel.Employees = empViewModels;
            employeeListViewModel.UserName = User.Identity.Name;
            return Ok(employees);
        }
}

以上是初阶的内容,进阶地址:

http://www.cnblogs.com/ruanyifeng/p/5455105.html

时间: 2024-08-19 01:18:41

重温ASP.NET WebAPI(一)初阶的相关文章

重温ASP.NET WebAPI(二)进阶

介绍 本文为个人对WebApi的回顾无参考价值. 本文内容: Rest和UnitOfWork 创建WebAPi的流程 IOC-Unity的使用 MEF 自定义URL Base认证和Token自定义权限 日志NLog OData的使用 Owin自宿主的使用 代码地址:https://github.com/OtherRuan/Review-Serials WebApi的几点特性 WebApi 提供了几点特性: 1. 自动匹配HTTP方法 GetMethod(), 惯例上会直接匹配Get的http方法

平衡树初阶——AVL平衡二叉查找树+三大平衡树(Treap + Splay + SBT)模板【超详解】

平衡树初阶——AVL平衡二叉查找树 一.什么是二叉树 1. 什么是树. 计算机科学里面的树本质是一个树状图.树首先是一个有向无环图,由根节点指向子结点.但是不严格的说,我们也研究无向树.所谓无向树就是将有向树的所有边看成无向边形成的树状图.树是一种递归的数据结构,所以我们研究树也是按照递归的方式去研究的. 2.什么是二叉树. 我们给出二叉树的递归定义如下: (1)空树是一个二叉树. (2)单个节点是一个二叉树. (3)如果一棵树中,以它的左右子节点为根形成的子树都是二叉树,那么这棵树本身也是二叉

Nodejs初阶之express

Nodejs初阶之express 2014-02-28 23:00 by 聂微东, 85627 阅读, 26 评论, 收藏, 编辑 PS: 2014/09/24 更新<Express 4.X 启航指南>,欢迎阅读和评论:) 老规矩,开头部分都是些自娱自乐的随想,想到哪写到哪... 到今天俺已经在俺厂工作俩年零几天了,工作以来头一回在一家企业工作超俩年,对于这俩年确实只有满满的成就感,不管是工作还是生活...写到这句突然又想写篇这俩年的总结,等这篇文章发了之后就着手整理吧,吼吼. 那篇<n

ASP.NET WebAPI 08 Message,HttpConfiguration,DependencyResolver

Message WebAPI作为通信架构必定包含包含请求与响应两个方法上的报文,在WebAPI它们分别是HttpRequestMessage,HttpResponseMessage.对于HttpResponseMessage之前在WebAPI返回结果中有应用. HttpRequestMessage 请求报文包含请求地址(RequestUri),请求方法(Method),头信息(Headers),报文信息(Content)以及Http版本(Versions) public class HttpRe

asp.net webapi 使用小结

一星期前公司用webapi处理一些事情,自己总结一下用法. 1.创建一个空的webapi会默认有一下几个方法. public class ValueController : ApiController { // GET api/value public IEnumerable<string> Get() { return new string[] { "value1", "value2" }; } // GET api/value/5 public st

使用ASP.Net WebAPI构建REST服务(六)——Self-Host

Asp.Net WebAPI生成的是一个程序集,并不是独立的进程,因此,要运行的时候必须将其承载在相应的宿主上,一般比较常见的是IIS承载.很多时候,我们为了简化部署或者功能集成,需要将其承载到独立的进程上,这种方式一般称之为Self-Host,本文就简单的介绍一下WebAPI的SefHost方法. 首先在Nuget上安装Microsoft.AspNet.WebApi.SelfHost库. 附上我们的WebAPI控制器 publicclassValuesController : ApiContr

使用ASP.Net WebAPI构建REST服务(四)——参数绑定

默认绑定方式 WebAPI把参数分成了简单类型和复杂类型: 简单类型主要包括CLR的primitive types,(int.double.bool等),系统内置的几个strcut类型(TimeSpan.Guid等)以及string.对于简单类型的参数,默认从URI中获取. 复杂类型的数据也可以直接作为参数传入进来,系统使用media-type formatter进行解析后传给服务函数.对于复杂类型,默认从正文中获取, 例如,对于如下函数 HttpResponseMessage Put(int

R语言 图形初阶

第三章 图形初阶 1.使用图形 pdf("XXX.pdf")#保存pdf文件 ---- dev.of() dev.new()#新的图形窗口 2.一个简单的列子 3.图形参数 opar=par(no.readonly=TRUE)#生成一个可以修改当前图形的参数列表 par(lty=2,pch=17) plot(x,y,type="b") par(opar) a.符号和线条 pch:指定绘制点时使用的符号 cex:指定符号的大小.cex是一个数值,表示绘图符号相对于默认

Asp.net WebApi + EF 单元测试架构 DbContext一站到底

其实关于webapi和Ef service的单元测试我以前已经写过相关文章,大家可以参考: Asp.net WebAPI 单元测试 单元测试 mock EF 中DbContext 和DbSet Include 先看一下项目结构图: 这个demo非常简单,UTWebApi.Data 是纯粹的数据定义,UTWebApi.Service是我们的业务服务逻辑层,UTWebApi 是我们webapi的实现,UTWebApi.Tests就是测试项目. 数据层: BloggerDbContext的构造函数一般