第二节:如何正确使用WebApi和使用过程中的一些坑

一. 基本调用规则

1. 前提

  WebApi的默认路由规则为:routeTemplate: "api/{controller}/{id}", 下面为我们统一将它改为 routeTemplate: "api/{controller}/{action}/{id}",这样我们在调用的时候,还是通过拼接方法名来识别,不用考虑上面的坑别的规则了,这里我单纯的来探讨WebApi的传参和调用。

2. 基本的调用规则

  是什么请求,在方法上面标注什么特性,常见的有[HttpGet][HttpPost][HttpPut][HttpDelete]。

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

 

二. Get请求规则

1. 标准用法:

  发起请求的方式都为 api/Second/CheckLogin?userName=admin&pwd=123456 这种类型,不管几个参数(1个或多个),接收的时候,如果是分参数接收,没有任何问题, 可以正常接收,但如果是通过实体类来接收,必须在前面加特性[FromUri],否则接收不到。

PS:当然也可以什么参数都不写,通过传统的Request或者Request.QueryString来接受。

2. 实战测试:

(1). 分别调用CheckLogin1、CheckLogin2、CheckLogin3方法, 发现前两个方法都能正常调用,CheckLogin3这个方法报错, 报:"Message":"出现错误","ExceptionMessage":"未将对象引用设置到对象的实例"。

(2). 调用CheckLogin4方法,报与上面相同的错误,证明dynamic类型也不能这么用。

(3). 调用CheckLogin5方法,能正常接收,表明可以通过传统的Request或者Request.QueryString来接受。

代码分享:

1   public class LoginModel
2     {
3         public string userName { get; set; }
4 
5         public string pwd { get; set; }
6     }

复制代码

  1         #region 01-分参数接收2         /// <summary>3         /// Get api/Second/CheckLogin1?userName=admin&pwd=1234564         /// </summary>5         /// <param name="userName"></param>6         /// <param name="pwd"></param>7         /// <returns></returns>8         [HttpGet]9         public string CheckLogin1(string userName, string pwd)10         {11             if (userName == "admin" && pwd == "123456")12             {13                 return "ok";14             }15             else16             {17                 return "error";18             }19         }20         #endregion21 22         #region 02-用实体接收,加[FromUri]特性23         /// <summary>24         /// Get api/Second/CheckLogin2?userName=admin&pwd=12345625         /// </summary>26         /// <param name="model"></param>27         /// <returns></returns>28         [HttpGet]29         public string CheckLogin2([FromUri]LoginModel model)30         {31             if (model.userName == "admin" && model.pwd == "123456")32             {33                 return "ok";34             }35             else36             {37                 return "error";38             }39         }40         #endregion41 42         #region 03-用实体接收,不加[FromUri]特性43         /// <summary>44         /// Get api/Second/CheckLogin3?userName=admin&pwd=12345645         /// </summary>46         /// <param name="model"></param>47         /// <returns></returns>48         [HttpGet]49         public string CheckLogin3(LoginModel model)50         {51             if (model.userName == "admin" && model.pwd == "123456")52             {53                 return "ok";54             }55             else56             {57                 return "error";58             }59         }60         #endregion61 62         #region 04-用dynamic接收,加[FromUri]特性63         /// <summary>64         /// Get api/Second/CheckLogin4?userName=admin&pwd=12345665         /// </summary>66         /// <param name="model"></param>67         /// <returns></returns>68         [HttpGet]69         public string CheckLogin4([FromUri]dynamic model)70         {71             if (model.userName == "admin" && model.pwd == "123456")72             {73                 return "ok";74             }75             else76             {77                 return "error";78             }79         }80         #endregion81 82         #region 05-没有任何参数,直接用Request相关方法接收83         /// <summary>84         /// Get api/Second/CheckLogin5?userName=admin&pwd=12345685         /// </summary>86         /// <param name="model"></param>87         /// <returns></returns>88         [HttpGet]89         public string CheckLogin5()90         {91             var userName = HttpContext.Current.Request["userName"];92             var pwd = HttpContext.Current.Request.QueryString["pwd"];93             if (userName == "admin" && pwd == "123456")94             {95                 return "ok";96             }97             else98             {99                 return "error";
100             }
101         }
102         #endregion

复制代码

复制代码

 1   //一.下面是Get请求的测试2             //1. 分参数接收,可以正常访问3             $("#getBtn1").click(function () {4                 $.ajax({ url: "/api/Second/CheckLogin1", type: "get", data: { userName: "admin", pwd: "123456" }, success: function (data) { alert(data); } });5             });6             //2. 用实体类接收,前面加[FromUrl],可以正常访问7             $("#getBtn2").click(function () {8                 $.ajax({ url: "/api/Second/CheckLogin2", type: "get", data: { userName: "admin", pwd: "123456" }, success: function (data) { alert(data); } });9             });
10             //3. 用实体类接收,前面什么不加,报错
11             // "Message":"出现错误","ExceptionMessage":"未将对象引用设置到对象的实例"
12             $("#getBtn3").click(function () {
13                 $.ajax({ url: "/api/Second/CheckLogin3", type: "get", data: { userName: "admin", pwd: "123456" }, success: function (data) { alert(data); } });
14             });
15             //4. 用dynamic接收,前面什么不加,报错
16             // "Message":"出现错误","ExceptionMessage":"未将对象引用设置到对象的实例"
17             $("#getBtn4").click(function () {
18                 $.ajax({ url: "/api/Second/CheckLogin4", type: "get", data: { userName: "admin", pwd: "123456" }, success: function (data) { alert(data); } });
19             });
20             //5. 后台直接用Request或者Request.QueryString,能正常接收
21             $("#getBtn5").click(function () {
22                 $.ajax({ url: "/api/Second/CheckLogin5", type: "get", data: { userName: "admin", pwd: "123456" }, success: function (data) { alert(data); } });
23             });

复制代码

3. 特别说明:

  建议忘掉实战测试中的几种错误情况,记住标准用法即可。

 

三. Post请求规则

1.标准用法:

  参数一定要用“实体类”接收(即使一个参数也要封装实体类),客户端既可以用ContentType="application/x-www-form-urlencoded"提交表单,也可以用 ContentType ="application/json"提交, 模型类前面可以加[FromBody],但只能在一个参数前面加.

2.实战测试

(1). 当只有一个参数的情况,且加[FromBody]特性,不封装实体,如Register0,正常的键值对 { userName: "admin" }能访问通,但后台拿不到值,只有省掉键名{ "": "admin" },才能正常访问,且后台能拿到值。

(2). 多个参数的情况,后台分参数接收,如Register1,正常的键值对提交,无法访问,提示找不到匹配的资源。

(3). 一个或多个参数的情况,后台用实体接收,如Register2,且加[FromBody]特性,可以正常访问,并获取到请求值。

  ①:默认的post请求,即ContentType="application/x-www-form-urlencoded"的形式,可以正常请求。

  ②:将post请求指定为contentType: 'application/json',且传递的实体格式化成Json字符串,则可以正常请求。

(4). 一个或多个参数的情况,后台用dynamic接收,且加[FromBody]特性,需要分情况讨论。

  ①:默认的post请求,即ContentType="application/x-www-form-urlencoded"的形式,服务器报500错误。

  ②:将post请求指定为contentType: 'application/json',且传递的实体格式化成Json字符串,则可以正常请求。

阶段总结:后台用实体接收和用dynamic类型接收,用实体接收,无论是"application/x-www-form-urlencoded"还是"application/json"都能访问;如果用dynamic类型接收,只有"application/json"能访问, 且参数必须是序列化后的字符串

(5). 一个或多个参数的情况,没有参数,如Register4,通过Request或者Request.Form相关方法可以获取请求值。

 代码分享:

复制代码

 1  #region 01-单个参数,加[FromBody]特性2         [HttpPost]3         public string Register0([FromBody]string userName)4         {5             if (userName == "admin")6             {7                 return "ok";8             }9             else
10             {
11                 return "error";
12             }
13         }
14         #endregion
15 
16         #region 02-多个参数,分参数接收
17         [HttpPost]
18         public string Register1(string userName, string pwd)
19         {
20             if (userName == "admin" && pwd == "123456")
21             {
22                 return "ok";
23             }
24             else
25             {
26                 return "error";
27             }
28         }
29         #endregion
30 
31         #region 03-用实体接收,加[FromBody]特性
32         [HttpPost]
33         public string Register2([FromBody]LoginModel model)
34         {
35             if (model.userName == "admin" && model.pwd == "123456")
36             {
37                 return "ok";
38             }
39             else
40             {
41                 return "error";
42             }
43         }
44         #endregion
45 
46         #region 04-用dynamic接收,加[FromBody]特性
47         [HttpPost]
48         public string Register3([FromBody]dynamic model)
49         {
50             if (model.userName == "admin" && model.pwd == "123456")
51             {
52                 return "ok";
53             }
54             else
55             {
56                 return "error";
57             }
58         }
59         #endregion
60 
61         #region 05-没有任何参数,直接用Request相关方法接收
62         [HttpPost]
63         public string Register4()
64         {
65             var userName = HttpContext.Current.Request["userName"];
66             var pwd = HttpContext.Current.Request.Form["pwd"];
67             if (userName == "admin" && pwd == "123456")
68             {
69                 return "ok";
70             }
71             else
72             {
73                 return "error";
74             }
75         } 
76         #endregion
77 
78 
79     }

复制代码

复制代码

 1  //二.下面是Post请求的测试(默认情况下为:ContentType="application/x-www-form-urlencoded"提交表单的形式)2             //PS: { userName: "admin", pwd: "123456" } 这就是一个JSON对象,也可以叫实体3 4             //1. 一个参数的情况,后台分参数接收,且必须加[FromBody]特性5             $("#postBtn0").click(function () {6                 //1.1 正常拼接,可以访问通,但是拿不到userName的值7                 $.ajax({ url: "/api/Second/Register0", type: "Post", data: { userName: "admin" }, success: function (data) { alert(data); } });8                 //1.2 没有键,只有值,可以正常访问,能拿到userName的值9                 //$.ajax({ url: "/api/Second/Register0", type: "Post", data: { "": "admin" }, success: function (data) { alert(data); } });
10             });
11             //2. 多个参数的情况,后台分参数接收,正常的键值对提交,无法访问,找不到匹配的资源
12             $("#postBtn1").click(function () {
13                 //访问不通
14                 $.ajax({ url: "/api/Second/Register1", type: "Post", data: { userName: "admin", pwd: "123456" }, success: function (data) { alert(data); } });
15             });
16             //3. 一个或多个参数的情况,后台用实体接收,且加[FromBody]特性,可以正常访问,并获取到请求值
17             $("#postBtn2").click(function () {
18                 //情况①,默认的post请求,即ContentType="application/x-www-form-urlencoded"的形式,可以正常请求
19                 //$.ajax({ url: "/api/Second/Register2", type: "Post", data: { userName: "admin", pwd: "123456" }, success: function (data) { alert(data); } });
20 
21                 //情况②,将post请求指定为contentType: 'application/json',且传递的参数格式化成Json字符串,则可以正常访问
22                 $.ajax({ url: "/api/Second/Register2", type: "Post", contentType: 'application/json', data: JSON.stringify({ userName: "admin", pwd: "123456" }), success: function (data) { alert(data); } });
23 
24             });
25             //4. 一个或多个参数的情况,后台用dynamic接收,且加[FromBody]特性,需要分情况讨论
26             $("#postBtn3").click(function () {
27                 //情况①,默认的post请求,即ContentType="application/x-www-form-urlencoded"的形式,服务器报500错误
28                 //$.ajax({ url: "/api/Second/Register3", type: "Post", data: { userName: "admin", pwd: "123456" }, success: function (data) { alert(data); } });
29 
30                 //情况②,将post请求指定为contentType: 'application/json',且传递的参数格式化成Json字符串,则可以正常访问
31                 $.ajax({ url: "/api/Second/Register3", type: "Post", contentType: 'application/json', data: JSON.stringify({ userName: "admin", pwd: "123456" }), success: function (data) { alert(data); } });
32             });
33             //5. 一个或多个参数的情况,没有参数,通过Request或者Request.Form相关方法可以获取请求值
34             $("#postBtn4").click(function () {
35                 //访问不通
36                 $.ajax({ url: "/api/Second/Register4", type: "Post", data: { userName: "admin", pwd: "123456" }, success: function (data) { alert(data); } });
37             });

复制代码

 

四. 总结

  Put和Delete请求与Post请求的规则相同,另外还有很多极端的情况,不探讨了,掌握正确的用法,直接去用最佳用法即可。

  总结:记住Get请求和Post请求的标准用法以及基本的调用规则,其他坑爹的情况,可以统统忘记了,注意的是ajax的Get请求,加上一个当前时间或者随机数的参数,使用HttpClient 等需要禁用缓存。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/438486.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

android 新闻功能列表,android根据提供的接口获取新闻列表

查询新闻列表&#xff1a;接口名称&#xff1a;GetNewsInfo接口参数&#xff1a;(string account(账号), string pwd(密码),string newstype(新闻类型[图文新闻(传入4)&#xff0c;图片链接(传入3)])string showArea(显示区域类型[首页(传入1)&#xff0c;监护页面(传入2)])str…

第三节:总结.Net下后端的几种请求方式(WebClient、WebRequest、HttpClient)

一. 前言 前端调用有Form表单提交&#xff0c;ajax提交&#xff0c;ajax一般是用Jquery的简化写法&#xff0c;在这里不再过多介绍&#xff1b; 后端调用大约有这些&#xff1a;WebCient、WebRequest、Httpclient、WebapiClient&#xff0c;重点探讨Get和Post请求&#xff0c;P…

android 传感器ceshi,Android代码-传感器-测试手机支持那几种传感

Android代码----传感器-----测试手机支持那几种传感一个小小Demo检测手机支持那几种传感&#xff1a;具体代码如下&#xff1a;[Java代码]DemoSensorActivity.javapackage com.example.testsensor;import java.util.List;import android.app.Activity;import android.content.C…

android studio lambda插件,Android Studio Lambda插件(gradle-retrolambda)安装

1.前言java jdk升级到1.8以上以后就可以使用lambda表达式了&#xff0c;其优点就是 高逼格 更简洁&#xff0c;需要注意的是 使不使用lambda 要看项目需求是否允许。本文简单介绍 Android Studio gradle-retrolambda插件的安装.2.在根build.gradle中进行如下配置buildscript {r…

第四节:跨域请求的解决方案和WebApi特有的处理方式

一. 简介 前言&#xff1a; 跨域问题发生在Javascript发起Ajax调用&#xff0c;其根本原因是因为浏览器对于这种请求&#xff0c;所给予的权限是较低的&#xff0c;通常只允许调用本域中的资源&#xff0c; 除非目标服务器明确地告知它允许跨域调用。假设我们页面或者应用已在 …

手机存储android文件怎么打开,安卓手机如何打开.jio文件?

01安卓手机无法打开.jio文件&#xff0c;需要在电脑上安装久其通用数据管理平台软件打开。进入软件首页&#xff0c;点击菜单栏“装入”按钮&#xff0c;弹出“数据装入向然后导”&#xff0c;单击文件夹图标&#xff0c;在弹出“打开”窗口中选择装入数据的路径&#xff0c;单…

第五节:WebApi的三大过滤器

一. 基本说明 1. 简介&#xff1a; WebApi下的过滤器和MVC下的过滤器有一些区别,首先我们要注意的是通常建WebApi项目时&#xff0c;会自动把MVC的程序集也引入进来&#xff0c;所以我们在使用WebApi下的过滤器的时候&#xff0c;要引入“ System.Web.Http”这个程序集&#x…

android动态贴纸实现原理,人脸动态贴纸sdk算法详解,人脸动态贴纸功能如何实现...

原标题&#xff1a;人脸动态贴纸sdk算法详解&#xff0c;人脸动态贴纸功能如何实现泛娱乐行业在互联网领域中发展趋势逐渐增强&#xff0c;而直播、短视频、视频社交等作为头部产品受到了众多用户的关注和喜爱。为了能够更好的满足用户体验&#xff0c;众多APP纷纷开始接入人脸…

第六节:WebApi的部署方式(自托管)

一. 简单说明 开篇就介绍过WebApi和MVC相比&#xff0c;其中优势之一就是WebApi可以不依赖于IIS部署&#xff0c;可以自托管&#xff0c;当然这里指的是 .Net FrameWork 下的 WebApi 和 MVC 相比较&#xff0c;在.Net Core下&#xff0c;当然就另行别论。 下面我们重点介绍的就…

第七节:WebApi与Unity整合进行依赖注入和AOP的实现

一. IOC和DI 1. 通过Nuget引入Unity程序集。 PS:【版本&#xff1a;5.8.6】 2. 新建DIFactory类&#xff0c;用来读取Unity的配置文件并创建Unity容器&#xff0c;需要注意的是DIFactory类需要声明成单例。 PS&#xff1a;这里采用静态构造函数(必须是无参的)的形式来实现单…

android 倒计时封装,react native中的聊天气泡及timer封装成的发送验证码倒计时

其实&#xff0c;今天我想把我近期遇到的坑都总结一下&#xff1a;1.goBack的跨页面跳转&#xff0c;又两种方法&#xff0c;一可以像兔哥那样修改navigation源码&#xff0c;二可以用navigationActions2.父子组件的传值&#xff0c;一可以用callBack 二可以用pubsub发布订阅模…

第八节:常见安全隐患和传统的基于Session和Token的安全校验

一. 常见的安全隐患 1. SQL注入 常见的案例&#xff1a; String query "SELECT * FROM T_User WHERE userID" Request["userID"] "; 这个时候&#xff0c;只需要在传递过来的userID后面加上个&#xff1a; or 11&#xff0c;即可以获取T_User表中…

android手机设置时间设置,如何设置电信定制手机日期与时间

使用电信定制手机如A765e、A600e、A560e等的时候&#xff0c;可能会发现手机的日期和时间没法自己设置。这主要是因为手机使用电信卡时&#xff0c;会自动与电信基站进行交互并自动调节日期与时间。所以不论使用电信定制的单模或双模手机(单模是指手机只有一个卡槽&#xff0c;…

第一节 特有标签

1.设置浏览器兼容版本 <meta http-equiv"X-UA-Compatible" content"IE8"> 表示IE浏览器默认版本为8 <meta http-equiv"X-UA-Compatible" content"IEedge"> 表示IE浏览器默认选择最高版本 2. 手机端特有…

第二节 CSS入门介绍

一.背景 这里将陆续介绍前端CSS中相关知识&#xff0c;先介绍CSS2.1&#xff0c;后续会介绍CSS3的相关属性&#xff0c;通过该系列的文章&#xff0c;希望能给准备转战前端的人员一些帮助&#xff0c;同时也帮助自己梳理知识&#xff0c;文章中如有错误&#xff0c;欢迎指出。 …

三星sec.android.soagent,3.0降级2.5教程

给小白看的。下载五件套&#xff0c;odia&#xff0c;驱动&#xff0c;地址&#xff1a;http://www.samsungmembers.cn/thread-1019962-110-150.html&#xff0c;或者自己论坛搜索&#xff0c;请下载G9810ZCU2BTJA&#xff0c;别下k3最后一个版本的会出问题&#xff0c;刷机后再…

第三节 入门属性

1.七个基本属性 颜色&#xff1a;color&#xff0c;背景颜色&#xff1a;background-color&#xff0c;字体大小&#xff1a;font-size&#xff0c;加粗&#xff1a;font-weight:bold&#xff0c;倾斜&#xff1a;font-style:italic&#xff0c; 文字居中&#xff1a;text-alig…

doc文件转换html,HTML+CSS入门 如何使用POI将doc文件转换为HTML

本篇教程介绍了HTMLCSS入门 如何使用POI将doc文件转换为HTML&#xff0c;希望阅读本篇文章以后大家有所收获&#xff0c;帮助大家HTMLCSS入门。<需要的jar包有&#xff1a;有一些是依赖包&#xff0c;可以使用maven下载doc文件转换为html文件package com.gsww.sxzz.controll…

第四节 CSS继承性和层叠性

一. 继承性 1. 含义&#xff1a;从自己开始直到所包裹的最小的元素&#xff0c;都可以继承一些特有的属性。 2. 作用范围&#xff1a; a. color、text-开头的、line-开头的、font-开头的&#xff0c;均可以继承。 b. 文字样式的&#xff0c;都能继承&#xff1b;所有关于盒子的…

html鼠标划过显示图片,jquery实现鼠标滑过小图查看大图的方法

本文实例讲述了jquery实现鼠标滑过小图查看大图的方法。分享给大家供大家参考。具体实现方法如下&#xff1a;1. CSS部分&#xff1a;ul{list-style:none;}li{float:left;margin-left:10px;}img{border:#CCCCCC solid 1px;}#max{position:absolute;display:none; /*隐藏层*/}2.…