WebApi接口传参不再困惑：传参详解

最新推荐文章于 2023-09-14 17:10:20 发布
最新推荐文章于 2023-09-14 17:10:20 发布
阅读量530 收藏
点赞数
分类专栏： C#类 Asp.Net MVC类 文章标签： c# WebApi


一、get请求

对于取数据，我们使用最多的应该就是get请求了吧。下面通过几个示例看看我们的get请求参数传递。

1、基础类型参数

[csharp]  view plain  copy
  1. [HttpGet]  
  2. public string GetAllChargingData(int id, string name)  
  3. {  
  4.     return "ChargingData" + id;  
  5. }  
[javascript]  view plain  copy
  1. $.ajax({  
  2.         type: "get",  
  3.         url: "http://localhost:27221/api/Charging/GetAllChargingData",  
  4.         data: { id: 1, name: "Jim", bir: "1988-09-11"},  
  5.         success: function (data, status) {  
  6.             if (status == "success") {  
  7.                 $("#div_test").html(data);  
  8.             }  
  9.         }  
  10.     });  
 这是get请求最基础的参数传递方式，没什么特别好说的。

2、实体作为参数

如果我们在get请求时想将实体对象做参数直接传递到后台，是否可行呢？我们来看看。

[csharp]  view plain  copy
  1. public class TB_CHARGING  
  2.     {  
  3.         /// <summary>  
  4.         /// 主键Id  
  5.         /// </summary>  
  6.         public string ID { get; set; }  
  7.   
  8.         /// <summary>  
  9.         /// 充电设备名称  
  10.         /// </summary>  
  11.         public string NAME { get; set; }  
  12.   
  13.         /// <summary>  
  14.         /// 充电设备描述  
  15.         /// </summary>  
  16.         public string DES { get; set; }  
  17.   
  18.         /// <summary>  
  19.         /// 创建时间  
  20.         /// </summary>  
  21.         public DateTime CREATETIME { get; set; }  
  22.     }  
[csharp]  view plain  copy
  1. [HttpGet]  
  2. public string GetByModel(TB_CHARGING oData)  
  3. {  
  4.      return "ChargingData" + oData.ID;  
  5. }  
[javascript]  view plain  copy
  1. $.ajax({  
  2.         type: "get",  
  3.         url: "http://localhost:27221/api/Charging/GetByModel",  
  4.         contentType: "application/json",  
  5.         data: { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" },  
  6.         success: function (data, status) {  
  7.             if (status == "success") {  
  8.                 $("#div_test").html(data);  
  9.             }  
  10.         }  
  11.     });  

测试结果： 在get请求时，我们直接将json对象当做实体传递后台，后台是接收不到的。这是为什么呢？我们来看看对应的http请求


[html]  view plain  copy
  1. <img src="http://images2015.cnblogs.com/blog/459756/201603/459756-20160331104121410-719598113.png" alt="" />  

原来，get请求的时候，默认是将参数全部放到了url里面直接以string的形式传递的，后台自然接不到了。

原因分析：还记得有面试题问过get和post请求的区别吗？其中有一个区别就是get请求的数据会附在URL之后（就是把数据放置在HTTP协议头中），而post请求则是放在http协议包的包体中。

根据园友们的提议，Get请求的时候可以在参数里面加上[FromUri]即可直接得到对象。还是贴上代码：

[javascript]  view plain  copy
  1. var postdata = { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" };  
  2.     $.ajax({  
  3.         type: "get",  
  4.         url: "http://localhost:27221/api/Charging/GetAllChargingData",  
  5.         data: postdata,  
  6.         success: function (data, status) { }  
  7.     });  
[csharp]  view plain  copy
  1. [HttpGet]  
  2.         public string GetAllChargingData([FromUri]TB_CHARGING obj)  
  3.         {  
  4.             return "ChargingData" + obj.ID;  
  5.         }  

得到结果：

如果你不想使用[FromUri]这些在参数里面加特性的这种“怪异”写法，也可以采用先序列化，再在后台反序列的方式。

[javascript]  view plain  copy
  1. $.ajax({  
  2.         type: "get",  
  3.         url: "http://localhost:27221/api/Charging/GetByModel",  
  4.         contentType: "application/json",  
  5.         data: { strQuery: JSON.stringify({ ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" }) },  
  6.         success: function (data, status) {  
  7.             if (status == "success") {  
  8.                 $("#div_test").html(data);  
  9.             }  
  10.         }  
  11.     });  
[csharp]  view plain  copy
  1. [HttpGet]  
  2.         public string GetByModel(string strQuery)  
  3.         {  
  4.             TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);  
  5.             return "ChargingData" + oData.ID;  
  6.         }  

这样在后台得到我们序列化过的对象，再通过反序列化就能得到对象。

在url里面我们可以看到它自动给对象加了一个编码：

3、数组作为参数

一般get请求不建议将数组作为参数，因为我们知道get请求传递参数的大小是有限制的，最大1024字节，数组里面内容较多时，将其作为参数传递可能会发生参数超限丢失的情况。

4、“怪异”的get请求

为什么会说get请求“怪异”呢？我们先来看看下面的两种写法对比。

（1）WebApi的方法名称以get开头

[javascript]  view plain  copy
  1. $.ajax({  
  2.         type: "get",  
  3.         url: "http://localhost:27221/api/Charging/GetByModel",  
  4.         contentType: "application/json",  
  5.         data: { strQuery: JSON.stringify({ ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" }) },  
  6.         success: function (data, status) {  
  7.             if (status == "success") {  
  8.                 $("#div_test").html(data);  
  9.             }  
  10.         }  
  11.     });  

[csharp]  view plain  copy
  1. [HttpGet]  
  2.         public string GetByModel(string strQuery)  
  3.         {  
  4.             TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);  
  5.             return "ChargingData" + oData.ID;  
  6.         }  

这是标准写法，后台加 [HttpGet] ，参数正常得到：

为了对比，我将[HttpGet]去掉，然后再调用

[csharp]  view plain  copy
  1. //[HttpGet]  
  2.       public string GetByModel(string strQuery)  
  3.       {  
  4.           TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);  
  5.           return "ChargingData" + oData.ID;  
  6.       }  

貌似没有任何问题！有人就想，那是否所有的get请求都可以省略掉[HttpGet]这个标注呢。我们试试便知。

（2）WebApi的方法名称不以get开头

我们把之前的方法名由GetByModel改成FindByModel，这个再正常不过了，很多人查询就不想用Get开头，还有直接用Query开头的。这个有什么关系吗？有没有关系，我们以事实说话。


[javascript]  view plain  copy
  1. $.ajax({  
  2.         type: "get",  
  3.         url: "http://localhost:27221/api/Charging/FindByModel",  
  4.         contentType: "application/json",  
  5.         data: { strQuery: JSON.stringify({ ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" }) },  
  6.         success: function (data, status) {  
  7.             if (status == "success") {  
  8.                 $("#div_test").html(data);  
  9.             }  
  10.         }  
  11.     });  

[csharp]  view plain  copy
  1. [HttpGet]  
  2.         public string FindByModel(string strQuery)  
  3.         {  
  4.             TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);  
  5.             return "ChargingData" + oData.ID;  
  6.         }  


貌似又可行，没有任何问题啊。根据上面的推论，我们去掉[HttpGet]也是可行的，好，我们注释掉[HttpGet]，运行起来试试。


结果是不进断点，有些人不信，我们在浏览器里面看看http请求：


呵呵，这就奇怪了，就改了个方法名，至于这样么？还真至于！

博主的理解是：方法名以Get开头，WebApi会自动默认这个请求就是get请求，而如果你以其他名称开头而又不标注方法的请求方式，那么这个时候服务器虽然找到了这个方法，但是由于请求方式不确定，所以直接返回给你405——方法不被允许的错误。

最后结论：所有的WebApi方法最好是加上请求的方式（[HttpGet]/[HttpPost]/[HttpPut]/[HttpDelete]），不要偷懒，这样既能防止类似的错误，也有利于方法的维护，别人一看就知道这个方法是什么请求。

这也就是为什么很多人在园子里面问道为什么方法名不加[HttpGet]就调用不到的原因！


二、post请求

在WebApi的RESETful风格里面，API服务的增删改查，分别对应着http的post/delete/put/get请求。我们下面就来说说post请求参数的传递方式。

1、基础类型参数

 post请求的基础类型的参数和get请求有点不一样，我们知道get请求的参数是通过url来传递的，而post请求则是通过http的请求体中传过来的，WebApi的post请求也需要从http的请求体里面去取参数。

（1）错误的写法

[javascript]  view plain  copy
  1. $.ajax({  
  2.         type: "post",  
  3.         url: "http://localhost:27221/api/Charging/SaveData",  
  4.         data: { NAME: "Jim" },  
  5.         success: function (data, status) {  
  6.             if (status == "success") {  
  7.                 $("#div_test").html(data);  
  8.             }  
  9.         }  
  10.     });  

[csharp]  view plain  copy
  1. [HttpPost]  
  2.         public bool SaveData(string NAME)  
  3.         {  
  4.             return true;  
  5.         }  

这是一种看上去非常正确的写法，可是实际情况是：


（2）正确的用法

[javascript]  view plain  copy
  1. $.ajax({  
  2.        type: "post",  
  3.        url: "http://localhost:27221/api/Charging/SaveData",  
  4.        data: { "": "Jim" },  
  5.        success: function (data, status) {}  
  6.    });  

[csharp]  view plain  copy
  1. [HttpPost]  
  2. public bool SaveData([FromBody]string NAME)  
  3. {  
  4.     return true;  
  5. }  

这是一种另许多人头痛的写法，但是没办法，这样确实能得到我们的结果：


我们一般的通过url取参数的机制是键值对，即某一个key等于某一个value，而这里的FromBody和我们一般通过url取参数的机制则不同，它的机制是=value，没有key的概念，并且如果你写了key(比如你的ajax参数写的{NAME:"Jim"})，后台反而得到的NAME等于null。不信你可以试试。

上面讲的都是传递一个基础类型参数的情况，那么如果我们需要传递多个基础类型呢？按照上面的推论，是否可以([FromBody]string NAME, [FromBody]string DES)这样写呢。试试便知。

（1）错误写法

[javascript]  view plain  copy
  1. $.ajax({  
  2.         type: "post",  
  3.         url: "http://localhost:27221/api/Charging/SaveData",  
  4.         data: { "": "Jim","":"备注" },  
  5.         success: function (data, status) {}  
  6.     });  

[csharp]  view plain  copy
  1. [HttpPost]  
  2.         public bool SaveData([FromBody]string NAME, [FromBody] string DES)  
  3.         {  
  4.             return true;  
  5.         }  

得到结果


这说明我们没办法通过多个[FromBody]里面取值，此法失败。

（2）正确用法

既然上面的办法行不通，那我们如何传递多个基础类型的数据呢？很多的解决办法是新建一个类去包含传递的参数，博主觉得这样不够灵活，因为如果我们前后台每次传递多个参数的post请求都去新建一个类的话，我们系统到时候会有多少个这种参数类？维护起来那是相当的麻烦的一件事！所以博主觉得使用dynamic是一个很不错的选择。我们来试试。

[javascript]  view plain  copy
  1. $.ajax({  
  2.         type: "post",  
  3.         url: "http://localhost:27221/api/Charging/SaveData",  
  4.         contentType: 'application/json',  
  5.         data: JSON.stringify({ NAME: "Jim",DES:"备注" }),  
  6.         success: function (data, status) {}  
  7.     });  

[csharp]  view plain  copy
  1. [HttpPost]  
  2.         public object SaveData(dynamic obj)  
  3.         {  
  4.             var strName = Convert.ToString(obj.NAME);  
  5.             return strName;  
  6.         }  

通过dynamic动态类型能顺利得到多个参数，省掉了[FromBody]这个累赘，并且ajax参数的传递不用使用"无厘头"的{"":"value"}这种写法，有没有一种小清新的感觉~~有一点需要注意的是这里在ajax的请求里面需要加上参数类型为Json，即 contentType: 'application/json', 这个属性。

（3）推荐用法

通过上文post请求基础类型参数的传递，我们了解到了dynamic的方便之处，为了避免[FromBody]这个累赘和{"":"value"}这种"无厘头"的写法。博主推荐所有基础类型使用dynamic来传递，方便解决了基础类型一个或多个参数的传递，示例如上文。如果园友们有更好的办法，欢迎讨论。


三、put请求

WebApi里面put请求一般用于对象的更新。它和用法和post请求基本相同。同样支持[FromBody]，同样可以使用dynamic。

1、基础类型参数

[javascript]  view plain  copy
  1. $.ajax({  
  2.         type: "put",  
  3.         url: "http://localhost:27221/api/Charging/Update",  
  4.         contentType: 'application/json',  
  5.         data: JSON.stringify({ ID: "1" }),  
  6.         success: function (data, status) {}  
  7.     });  

[csharp]  view plain  copy
  1. [HttpPut]  
  2.         public bool Update(dynamic obj )  
  3.         {  
  4.             return true;  
  5.         }  


2、实体作为参数

和post请求相同。

3、数组作为参数

和post请求相同。

四、delete请求

顾名思义，delete请求肯定是用于删除操作的。参数传递机制和post也是基本相同。下面简单给出一个例子，其他情况参考post请求。

[javascript]  view plain  copy
  1. var arr = [  
  2.         { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" },  
  3.         { ID: "2", NAME: "Lilei", CREATETIME: "1990-12-11" },  
  4.         { ID: "3", NAME: "Lucy", CREATETIME: "1986-01-10" }  
  5.     ];  
  6.     $.ajax({  
  7.         type: "delete",  
  8.         url: "http://localhost:27221/api/Charging/OptDelete",  
  9.         contentType: 'application/json',  
  10.         data: JSON.stringify(arr),  
  11.         success: function (data, status) {}  
  12.     });  


 

[csharp]  view plain  copy
  1. [HttpDelete]  
  2.         public bool OptDelete(List<TB_CHARGING> lstChargin)  
  3.         {  
  4.             return true;  
  5.         }  

五、总结

以上比较详细的总结了WebApi各种请求的各种参数传递。每种情况都是博主实际代码测试过的，内容不难，但如果刚接触这么些东西还是需要一点时间去熟悉的，在此做个总结，希望能帮到刚刚接触WebApi的园友们。如果本文能帮到你，不妨推荐下，您的推荐是博主继续总结的动力！

原文地址： http://www.cnblogs.com/landeanfen/p/5337072.html
Denghejing
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
C# WebApi 接口传参详解
08-27
主要介绍了C# WebApi 接口传参详解，本篇打算通过get、post、put、delete四种请求方式分别谈谈基础类型（包括int/string/datetime等）、实体、数组等类型的参数如何传递。感兴趣的小伙伴们可以参考一下
Apipost发送一个值是数组的参数（form-data/x-www-form-urlencoded）
weixin_47715239的博客
05-28 1万+
假如您要在Apipost发送一个数组，其实有2种情况。 情况1: 请求方式为 form-data/x-www-form-urlencoded 等表单类型时，您可以通过以下方式传递数组。 情况2: 请求方式为application/json时，您可以通过以下方式传递数组。 区别: 不同请求方式的后台接收数据方式不同，请您根据实际后端接收方式选择对应的方式。 推荐阅读： ApiPost中form-data、x-www-form-urlencoded、raw 的区别：https://mp.apipost.cn
请求参数为数组,如何传参?
热门推荐
qq_34365469的博客
08-01 2万+
引言: 在工作中,有时后会遇见post请求的参数为数组的情况,这种情况应该如何解决呢? 如下图: 想法一: 直接把数组放入变量池中,查阅API文档中发现如下方法: 其中主要的方法: putObject(String key,Object value),可以任何类型的数据放入变量池; getObject(String key),取出变量名代表的任何类型的数据。 现在的场景是要讲...
接口测试传递数组参数
xie_0723的博客
05-24 9957
最近在做接口自动化测试的时候，遇到一个问题，传递的接口参数，有一个参数为数组形式，不知道该如何传递，最终花费1,2个小时才找到方法，记录下 """ 接口url：http://xx.xx.xx/api/case/add? 接口参数：name，create_uid，model_attr_pairs 其中model_attr_pairs传递的是一个数组 请求方法：get 返回值：json
C# WebApi 接口返回值不困惑：返回值类型详解
12-31
之前分享过一篇C#进阶系列——WebApi接口传参不再困惑：传参详解，这篇博文内容本身很基础，没想到引起很多园友关注，感谢大家的支持。作为程序猿，我们都知道参数和返回值是编程领域不可分割的两大块，此前分享了下...
WebApi接口返回值不困惑：返回值类型详解 - 文章 - 伯乐在线1
08-04
//摘要:// Defines a command that asynchronously creates an
.NET Core WebAPI Get请求参数传入输入不识别问题
代码笔记
03-12 1790
参考了：https://www.cnblogs.com/zhaozhengyan/p/aspnet-core-webapi-array-handle.html ①.NET Core WebApi项目里添加一个ArraryHandleQueryConvention.cs 类文件，其内容如下： using Microsoft.AspNetCore.Http; using Microsoft.A...
WebApi传递JSON参数
weixin_30612769的博客
01-25 761
开发过程中经常进行JSON的传递，在WebApi中传递JSON字串时，会发现服务器端接收到不参数值，看下面代码 服务端： public void Post([FromBody]string value) { LoggerHelper.Info("Post:{0}", value); } 客户端： HttpClient...
API对接是一种在不同系统或应用程序之间共享数据和功能的方式
最新发布
wbryze的博客
09-14 253
本文讨论了五个关键方面，包括API定义和规范、身份验证和授权、错误处理和异常处理、数据一致性和完整性、性能和安全性以及文档和支持。请求和响应的头部信息：定义与API请求和响应相关的任何头部信息，如Content-Type、Authorization等。授权：了解API的授权机制，并确保以正确的方式提供授权信息，例如在请求头中提供Token等。文档可用性：确保API的文档易于访问，并清晰地描述API的使用方法和细节。API的功能描述和返回值：为API提供清晰的功能描述以及预期的返回值。
关于API开发（用户授权和接口授权两种方式）
liNewman的博客
12-09 3634
关于API开发（用户授权和接口授权两种方式） 基于微信API文档的研究学习： 用户授权和接口授权是两种方式。 接口授权先取token 然后可调用任意接口。 而用户授权的token 仅仅是用户中使用的，和普通token 没有任何关系。 总结：用户授权和接口调用的token  两码事。 OAuth的机制原理 分为OAuth1...
接口总结--vue前后端接口对接，传递数值的不同形式（表单formData\json\拼接url等）
weixin_43312391的博客
02-23 1万+
后端一般要求的传递方式：get 和 post 1.传递的为普通参数(get) 2.传递数组对象形式 3.传递表单形式 .......
前后端分离开发，HTTP API 认证授权术
lisheng19870305的专栏
12-16 961
前后端分离登录，是个说不完的话题，最近刚好看到一篇干货，和各位小伙伴们分享下。另外，在公众号后台回复 2TB，可以获取松哥独家超 2TB 免费 Java 学习资源。 我们知道，HTTP 是无状态的，所以，当我们需要获得用户是否在登录的状态时，我们需要检查用户的登录状态，一般来说，用户的登录成功后，服务器会发一个登录凭证（又被叫作 Token），就像你去访问某个公司，在前台被认证过合法后，这个...
Web API接口鉴权方式
人间世
02-28 4868
介绍web API接口的鉴权方式
.net core webapi常用传递方式
高彬的专栏
09-29 1596
一、传数组 js: return request({ url: '', method: 'post', data:[1,2,3] }) 服务端写法: [HttpPost] public Response 方法名([FromBody] string[] ids) {}//ids的名称自定义 二、传一个对象集合（传单个对象的方法与之相同） 如实体类叫 student: class student{ name{get;set;} age{get;
C# 解决HttpWebRequest后台POST请求调用WebApi参数传递问题
a923401929的博客
05-15 2836
最近开发了一个WebApi项目，需要再后台请求，发现进行POST调用时，参数始终传递不过去，经过各种尝试终于找到解决方法。 客户端： string strContent = "{'data':'123'}"; string sss = HttpPost("http://192.168.1.128:8025/api/Demo/GetResult", strCon...
ApiPost/Postman 传参赋值详解
Jie_Li_Wen的博客
02-21 1万+
当使用getMapping()时，使用@requestParam("strs")ApiPost还有一种写法：当使用PostMapping()时，使用requestBodyAPIPost即：如果是List详细说一下：如果使用requestParam 注意里的value一定要带上中括号：或者。
WebAPI 为什么你的[FromBody]参数总是为NULL
qq_42335551的博客
03-16 3938
出于某种原因，我总是忘记Web API参数绑定的工作原理。无数次，我的[FromBody]参数为NULL。 有时间整理一下并写下来，防止以后再犯同样的错误。 大家可以阅读关于Web API中参数绑定的官方文档parameter-binding-in-aspnet-web-api 言归正传，这是我最初的请求，测试时不起作用： $.ajax({ type: "POST", ...
WebAPI接收二维数组
wu_zz的博客
01-29 1033
做安卓手持时，需要将扫描到的轮胎条码号传递给后台接口，由于是二维数组后台不知该如何接收，再次记录下； 前台post数据： items: any = { 'one': [], 'two': [], 'three': [], 'four': [], 'five': [] }; inStorageConfim() { if (this.items
在webapi中如何调用其他webapi接口
06-09
在Web API中可以使用HttpClient类来调用其他的Web API接口。具体步骤如下： 1. 创建HttpClient对象，可以使用using语句块来确保 HttpClient 对象在使用完毕后被正确地释放。 2. 使用HttpClient对象的GetAsync、...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值