c# 进阶之 WebAPI

REST是设计风格而不是标准。

webapi有自己的路由。

webservice和wcf的协议都是soap协议,数据的序列化和反序列化都是soap的格式。而webapi是Json的数据传递

webapi的优点有哪些?

(1)非常适合做http的请求,前端与webapi交互特别方便

(2)webapi更轻量因为使用的json数据来传递。

(3)webapi很多时候是给前端提供数据的,因为webapi跟控制器关联的没那么紧密(若是没webapi,用mvc的模式,那么页面直接从对应的控制器获取数据),这样传递数据webapi对,手机,app,页面都可以通过同一个数据源提供数据,会比较灵活一些。(会跨域)

(一)配置webapi,访问

第一步:新建项目后,找到Global.asax文件----找到GlobalConfiguration.Configure(WebApiConfig.Register)方法------按F12进入 WebApiConfig.Register方法中----添加内容红框框

知识点:路由器注册顺序是由上往下的,会先从上面进行匹配。

路由器的名称不能重名,否则报错【CustomApi/DefaultApi】

第二步:设置webapi项目为启动项,然后启动,在网页路径上加api/values(控制器名称不要Controller)

知识点:因为ValuesController是项目自带的,那么这一次的请求与 DefaultApi的路由规格是一致的。

但显示的结果应该Values控制器中的get方法的,也就是应该是访问api/values/get。实际上api风格是不需要的get,rest也不需要get,会自动找到这个get的。若是把这个路径放到别的浏览器会直接得到json格式的数据

(2)如何去使用webapi?页面获取数据通过api提供,不通过控制器

知识点:1.ajax中的type有四种方式:get(查询),post(修改),delete(删除),put(插入) 。

2.写webapi时,在后台的方法最好将特性标记号对应上[HttpGet],[HttpPost],[HttpDelete],[HttpPut]。http请求和rest风格的api如果不想在后台方法写特性,但也可以将方法名以Get开头,否则会报错。

get:若是查询数据,通过get,其实get请求会将参数拼装到url上面,而url长度是有限的

post:若是对原有数据新增和修改就用post,多用post即可。post不是将参数放在url上面的,而是放在表单上的。

3.传递的参数username名一定要相同,但是大小写可以不一样。

4.若是user={name:"张苏纳",id:123,age:‘19‘} 然后data:user那么在后台是接收不到的,即使在页面调试时是可以看到数据。若是想接收到的话,需要在后台写成GetUserModeuri([FormUri]Users user)。

5.基于第4的另一种方法。可以将user序列化转化为一个字符窜,然后后台接收后反序列化即可得到。data:{userString:JSON.stringify(user)}

6.(1)若是通过post请求的时候,是将数据放在from data里面的,若是传递单个参数,不要在ajax上不要写对应参数。

(2)只有不写id才能得到,与[formbody]无关。若是通过post传递实体,那么在后台可以直接拿到 ,不需要任何转化。

(3)当然也可以通过data:Json.stringify(user)      contentType:‘application/json‘(contentType默认是json类型的)来在后台同样得到。

(4)若是参数包含了一个实体,还有一个字符串参数data:{"User":user,"Info":info}该怎么办,可以通过引用Newtonsoft.Json.Linq的JObject类型。jObject.ToObject是一个序列化方法,将josn转化为对象。

7.dynamic动态类型,比如一个实体和一个参数放到同一个对象中,获取对象后,然后dynamic json=jData; var mm= json.user,动态类型是可以直接访问属性的。

8.put和post是一样的使用,put主要是插入数据使用。

9.delete也是一样的。

10.webapi最方便的是给前端使用。

get方式:单个参数,实体

post方式:第一种:单个参数

第二种:通过传实体或实体+参数

******************************以上都是前端的调用****************************************************

*******************************以下是后端的调用*****************************************************

1、后端调用也是通过模拟http请求,有两种方式:HttpClient(4.0才出现),HttpWebRequest(更灵活)

//得到调用该方法就可以得到  HttpClient方式实现get请求
private string GetClient(){string url="http://localhost:9008/api/users/GetUserByName?username=superman";
var handler=new HttpClientHandler();
using(var http=new HttpClient(handler)){
  var response=http.GetAsync(url).Result;//拿到异步结果
  cw(response.StatusCode);//确保http成功状态值
  //await异步读取最后的JSON(注意此时gzip已经被自动解压缩了,因为上面的AutomaticDecompression=DecompressionMethods.G)
   return response.Content.ReadAsStringAsync().Result;

}
}

//得到调用该方法就可以得到  HttpWebRequest方式 实现get请求
private string GetWebQuest(){
string url="http://localhost:9008/api/users/GetUserByName?username=superman";
HttpWebRequest request
using(var http=new HttpClient(handler)){
  var response=http.GetAsync(url).Result;//拿到异步结果
  cw(response.StatusCode);//确保http成功状态值
  //await异步读取最后的JSON(注意此时gzip已经被自动解压缩了,因为上 面的AutomaticDecompression=DecompressionMethods.G)
   return response.Content.ReadAsStringAsync().Result;

}
}
时间: 2024-11-10 11:35:26

c# 进阶之 WebAPI的相关文章

C#进阶系列——WebApi 接口测试工具:WebApiTestClient

C#进阶系列--WebApi 接口测试工具:WebApiTestClient 前言:这两天在整WebApi的服务,由于调用方是Android客户端,Android开发人员也不懂C#语法,API里面的接口也不能直接给他们看,没办法,只有整个详细一点的文档呗.由于接口个数有点多,每个接口都要详细说明接口作用.参数类型.返回值类型等等,写着写着把博主惹毛了,难道这种文档非要自己写不成?难道网上没有这种文档的展示工具吗?带着这两个问题,在网络世界里寻找,网络世界很奇妙,只要你用心,总能找到或多或少的帮助

C#进阶系列——WebApi 跨域问题解决方案:CORS

from:http://www.cnblogs.com/landeanfen/p/5177176.html 阅读目录 一.跨域问题的由来 二.跨域问题解决原理 三.跨域问题解决细节 1.场景描述 2.场景测试 四.总结 正文 前言:上篇总结了下WebApi的接口测试工具的使用,这篇接着来看看WebAPI的另一个常见问题:跨域问题.本篇主要从实例的角度分享下CORS解决跨域问题一些细节. WebApi系列文章 C#进阶系列--WebApi接口测试工具:WebApiTestClient C#进阶系列

C#进阶系列——WebApi 接口参数不再困惑:传参详解

C#进阶系列--WebApi 接口参数不再困惑:传参详解

[转]C#进阶系列——WebApi 接口返回值不困惑:返回值类型详解

本文转自:http://www.cnblogs.com/landeanfen/p/5501487.html 阅读目录 一.void无返回值 二.IHttpActionResult 1.Json(T content) 2.Ok(). Ok(T content) 3.NotFound() 4.其他 5.自定义IHttpActionResult接口的实现 三.HttpResponseMessage 四.自定义类型 五.总结 正文 前言:已经有一个月没写点什么了,感觉心里空落落的.今天再来篇干货,想要学

C#进阶系列——WebApi 异常处理解决方案

前言:上篇C#进阶系列——WebApi接口传参不再困惑:传参详解介绍了WebApi参数的传递,这篇来看看WebApi里面异常的处理.关于异常处理,作为程序员的我们肯定不陌生,记得在介绍 AOP 的时候,我们讲过通过AOP可以统一截获异常.那么在我们的WebApi里面一般是怎么处理异常的呢,今天这一篇,博主带着大家一起来实践下WebApi的异常处理. WebApi系列文章 C#进阶系列——WebApi接口测试工具:WebApiTestClient C#进阶系列——WebApi 跨域问题解决方案:C

C#进阶系列——WebApi 身份认证解决方案:Basic基础认证

前言:最近,讨论到数据库安全的问题,于是就引出了WebApi服务没有加任何验证的问题.也就是说,任何人只要知道了接口的url,都能够模拟http请求去访问我们的服务接口,从而去增删改查数据库,这后果想想都恐怖.经过一番折腾,总算是加上了接口的身份认证,在此记录下,也给需要做身份认证的园友们提供参考. WebApi系列文章 C#进阶系列--WebApi接口测试工具:WebApiTestClient C#进阶系列--WebApi 跨域问题解决方案:CORS C#进阶系列--WebApi身份认证解决方

C#进阶系列——WebApi 异常处理解决方案(转)

出处:http://www.cnblogs.com/landeanfen/p/5363846.html 阅读目录 一.使用异常筛选器捕获所有异常 二.HttpResponseException自定义异常信息 三.返回HttpError 四.总结 正文 前言:上篇C#进阶系列——WebApi接口传参不再困惑:传参详解介绍了WebApi参数的传递,这篇来看看WebApi里面异常的处理.关于异常处理,作为程序员的我们肯定不陌生,记得在介绍 AOP 的时候,我们讲过通过AOP可以统一截获异常.那么在我们

.Net高级进阶,WebApi和MVC进行模型验证的时候,教你如何自由控制需要进行验证的字段?

现在,你有一个MVC架构的web项目,你要完成一个注册功能. 前台传了3个值到你的控制器,分别是账号.密码.邮箱. 如图:现在你要在控制器里面判断,账号名称.密码.邮箱不能为空,并且名称和密码不超过16位. 上面这个图只是个理想中的小例子,实际开发情况是,可能一次性要传十几个字段甚至更多. 那么在实际开发中,通常为了复用性,我们将这3个参数用一个实体类来代替. 即如下所示. 注:这一步会有个知识点,叫做模型验证,不懂的童鞋可以百度下,MVC会通过一定规则自动直接将参数反序列化成所对应的实体类,但

C#进阶系列——WebApi 路由机制剖析:你准备好了吗?

前言:从MVC到WebApi,路由机制一直是伴随着这些技术的一个重要组成部分. 它可以很简单:如果你仅仅只需要会用一些简单的路由,如/Home/Index,那么你只需要配置一个默认路由就能简单搞定: 它可以很神秘:你的url可以千变万化,看到一些看似“无厘头”的url,感觉很难理解它如何找到匹配的action,例如/api/user/1/detail,这样一个url可以让你纠结半天. 它可以很晦涩:当面试官提问“请简单分析下MVC路由机制的原理”,你可能事先就准备好了答案,然后噼里啪啦一顿(型如