Asp.Net Core Web Api 路由传参探幽

最新推荐文章于 2025-06-02 00:55:18 发布
转载 最新推荐文章于 2025-06-02 00:55:18 发布 · 3.1k 阅读 · 9 ·
CC 4.0 BY-SA版权
原文链接：https://blog.youkuaiyun.com/WuLex
文章标签：

#json #NET Core #Web Api #.netcore

本文详细介绍了ASP.NET Core Web API中各种参数传递方式，包括query、route、header、form、body的使用场景和限制。例如，query只能传递简单类型，而接收方可以是简单或复杂类型；route和header只能传递简单类型；body只能传递JSON，且只能有一个[FromBody]参数。此外，还讨论了值类型和引用类型在未传值或传不匹配值时的默认行为，以及如何根据接收到的值推断客户端的传参形式。

不同的方式传参

本文需要用到的自定义复杂类型：

public class Student
{
    public int Age { get; set; }
    public string Name { get; set; }
    public string Color { get; set; }
}

query传参

1.简单类型-简单类型

[HttpGet]
public ActionResult Get(string a, int b);

http://localhost:5000/api/values?a=aaa&b=111

2.简单类型-复杂类型

[HttpGet]
public ActionResult Get(Student student);

http://localhost:5000/api/values?age=11&name=jack&color=red

3.Json-简单类型，复杂类型

query没必要用json来传递简单类型

query无法将Json格式的字符串直接映射到复杂类型，可能是复杂类型会忽略其名称（student）。但是可以传递Json格式的字符串至一个字符串接收器，随后可以二次解析。

总结：query只能传递简单类型，而接受方则可以是简单类型和复杂类型

Route传参

  1. 路由也只能传递简单数据类型（路由本身不可能是复杂类型）
  2. 不是路由中的任何值都能做参数
[HttpGet("id")]
public ActionResult Get(int id);

http://localhost:5000/api/values/id?id=5

此时，路由中的第一个id并没有做参数，而是单纯的路由，且不可以被省略，否则会找不到路由

  1. 将路由当做参数
[HttpGet("{id}")]
public ActionResult Get(int id)

http://localhost:5000/api/values/6

将路由中id加上{}后就能将id当做参数了。即使后面再跟别的query id，后面的id也不会起作用了。

如果将路由中6改成字符串，则id的值为默认的0

  1. 可以指定多级路由来传递至复杂类型
[HttpGet("{Age?}/{Name?}/{Color?}")]
public ActionResult Get(int Age, Student student)

http://localhost:5000/api/values/8/shang/red

总结：route只能传递简单类型，而接受方则可以是简单类型和复杂类型

Header传参

header出传参必须加[FromHeader]，否则无法识别

1.简单类型-简单类型

[HttpGet()]
public ActionResult Get([FromHeader]int age, [FromHeader]string name, [FromHeader]string color)

http://localhost:5000/api/values/

在这里插入图片描述
2.简单类型-复杂类型

[HttpGet()]
public ActionResult Get([FromHeader]Student student)

注意：无法通过简单类型传递到复杂类型

3.Header传递的Json字符串无法被识别

总结：header只能传递简单类型，而接受方则也只能是简单类型

From传参

1.简单类型-简单类型

[HttpGet()]
public ActionResult Get([FromHeader]int age, [FromHeader]string name, [FromHeader]string color)

http://localhost:5000/api/values/

在这里插入图片描述

2.简单类型-复杂类型

[HttpGet()]
public ActionResult Get(Student student)

http://localhost:5000/api/values/

在这里插入图片描述

3.无法用json传递

在这里插入图片描述
4.传文件

看我写的模型绑定那篇文章

总结：form只能传递简单类型，而接受方则可以是简单类型和复杂类型

Body传参

  1. Body传参也必须加上[FromBody]属性，否则无法识别
  2. asp.net core默认接收json格式的数据，除非设置了其他格式的解析，本文只采用json来传参。想要添加xml格式的解析，或者添加自定义解析可以看官方文档。
  3. Body不存在简单类型和复杂类型，就是Json格式
  4. 一个参数列表只能存在一个[FromBody]
  5. json-简单类型
[HttpGet()]
public ActionResult Get([FromBody]string name)

body无法传递简单数据

6.json-复杂类型

[HttpGet()]
public ActionResult Get([FromBody]Student student);

http://localhost:5000/api/values/

总结：body只能传递json字符串，而接受方只能是复杂类型

同时指定参数

如果这几种传参方式同时指定了值，那么会选择谁呢?

由于header和body都需要指定[FromXXX]属性，所以不需要考虑了。

测试结果：

1.当form，query，route同时指定时，选择form

http://localhost:5000/api/values/route?name=query

在这里插入图片描述
2.当query，route同时指定时，选择route

http://localhost:5000/api/values/route?name=query

默认值

值类型

1.不传值

[HttpGet()]
public ActionResult Get(int a, bool b, DateTime c);

http://localhost:5000/api/values/

结果：
在这里插入图片描述

2.传匹配类型的值

[HttpGet()]
public ActionResult Get(int a, bool b, DateTime c);

http://localhost:5000/api/values?a=11&b=true&c=1992-01-02

结果：
在这里插入图片描述
3.传不匹配类型的值

[HttpGet()]
public ActionResult Get(int a, bool b, DateTime c);

http://localhost:5000/api/values?a=11&b=name&c=19920102

结果：

总结：值类型如果不传值或者传不匹配的值，则值为该类型的默认值。传匹配的值则正确接收值

引用类型

1.不传值

[HttpGet()]
public ActionResult Get(Student student,string other);

http://localhost:5000/api/values

结果：
在这里插入图片描述
2.传配类型的数据

[HttpGet()]
public ActionResult Get(Student student,string other);

http://localhost:5000/api/values?age=11&name=zhang&color=red&other=sui

结果：
在这里插入图片描述
3.引用类型不存在不匹配的数据

总结：string类型的数据不传值则为null，传值则为该值。复杂类型本身不为null（实际上asp.net core会在内部调用它的默认构造函数），但是它包含的属性（值类型，引用类型）都遵循前述规则

由服务端接收到的值推断客户端的传参形式

值类型

1.服务端接收到的值为除默认值外的值

客户端传值了

2.服务端接收到了默认值

客户端没传值，客户端传了个不符合类型的值，客户端传了默认值

解决办法：

客户端没传值：用可空类型约束

客户端传了不符合类型的值：校验ModelState

客户端传了默认值：正确，不用做

总结：要根据服务端接收到的值推断客户端的具体行为采用的方法是可空类型+ModelState。可以判断客户端想要将值设为另外一个值还是不改动（为null则不改动，为数值类型包括默认值则就为该值）

引用类型

1.服务端接到的值不为null

客户端传了正确的值

2.服务端接收到的值为null

客户端没传值，客户端传了空白

http://localhost:5000/api/values
http://localhost:5000/api/values?name=
http://localhost:5000/api/values?name=空格

解决办法

设置默认值

HttpContext.Form.ContainsKey("key")

总结：当一个引用类型无法判断是想修改值还是不修改值时，可以用设置默认值的方式，接收到默认值，说明是不修改值，接收null则表示将值改为null。还可以直接获取HttpContext信息，判断该参数有还是没有，没有说明不需要改。有，如果为null，则置为null。有，如果不为null，则置为该值。

https://blog.youkuaiyun.com/qq_34759481/article/details/102755686

详解ASP.NET Core WebApi 返回统一格式参数

业务场景：

业务需求要求，需要对 WebApi 接口服务统一返回参数，也就是把实际的结果用一定的格式包裹起来，比如下面格式：

{
  "response":{
    "code":200,
    "msg":"Remote service error",
    "result":""
  }
}

具体实现：

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
 
public class WebApiResultMiddleware : ActionFilterAttribute
{
  public override void OnResultExecuting(ResultExecutingContext context)
  {
    //根据实际需求进行具体实现
    if (context.Result is ObjectResult)
    {
      var objectResult = context.Result as ObjectResult;
      if (objectResult.Value == null)
      {
        context.Result = new ObjectResult(new { code = 404, sub_msg = "未找到资源", msg = "" });
      }
      else
      {
        context.Result = new ObjectResult(new { code = 200, msg = "", result = objectResult.Value });
      }
    }
    else if (context.Result is EmptyResult)
    {
      context.Result = new ObjectResult(new { code = 404, sub_msg = "未找到资源", msg = "" });
    }
    else if (context.Result is ContentResult)
    {
      context.Result = new ObjectResult(new { code = 200, msg = "", result= (context.Result as ContentResult).Content });
    }
    else if (context.Result is StatusCodeResult)
    {
      context.Result = new ObjectResult(new { code = (context.Result as StatusCodeResult).StatusCode, sub_msg = "", msg = "" });
    }
  }
}

Startup添加对应配置：

public void ConfigureServices(IServiceCollection services)
{
  services.AddMvc(options =>
  {
    options.Filters.Add(typeof(WebApiResultMiddleware));
    options.RespectBrowserAcceptHeader = true;
  });
}

.net core webapi常用传递方式

一、传数组

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;set;}
}

js:

  return request({
    url: '',
    dataType: "json",
    contentType: "application/json;charset=utf-8",
    method: 'post',
    data:rows  //rows是一个数组，里面是json对象，如：[{name:"a",age:1},{name:"b",age:2}]
  })

服务端方法：

[HttpPost]
public Response 方法名([FromBody] List<student> rows){}//其中rows是形参名，自定义

三、同时传集合和其他参数

//js：  
return request({
    url: '',
    dataType: "json",
    contentType: "application/json;charset=utf-8",
    method: 'post',
    params: { a:"123" },
    data:rows//rows是一个数组，里面是json对象，如：[{name:"a",age:1},{name:"b",age:2}]
  })

//服务端
[HttpPost]
public Response 方法名([FromBody] List<student> rows, [FromQuery] string a)

.NET Core WebAPI post参数传递时后端的接收方式

  1. 实体类
  2. dynamic动态类型
  3. JObject参数
  4. 单值参数(字符串参数)

A.前端Post请求代码

$.ajax({
           url: "/api/student/poststudent",
           type: 'POST',
           data:JSON.stringify({ name: "张三", age: 21 }),
           success:function () {
           },
           dataType: "json",
           contentType: "application/json"
       });

B.后端接收参数方式

1. 实体类

实体类是比较简单的一种传参方式，使用频率非常高。

  1. 添加实体类
public class Student
{
    public string Name { get; set; }
    public int Age { get; set; }
}
  1. 后台处理Post请求代码
[HttpPost("{id}")]
public void PostStudent(Student student)
{
}
  1. 接收参数结果
    在这里插入图片描述

2.dynamic动态类型

  1. 后台处理Post请求代码
[HttpPost("{id}")]
public void PostStudent(dynamic student)
{
    var name = student.name;//name大小写与前端参数一致
    var age = student.age;
}
  1. 接收参数结果
    在这里插入图片描述

3.JObject参数

  1. 引入Microsoft.AspNetCore.Mvc.NewtonsoftJson包
  2. 添加引用 using Newtonsoft.Json.Linq;
  3. 后台处理Post请求代码
[HttpPost("{id}")]
public void PostStudent(JObject student)
{
}
  1. 接收参数结果
    在这里插入图片描述

4.单值参数(字符串参数)

只能传一个字符串参数，并且用单引号包一个双引号，双引号里为字符串内容！
2. 前端代码与以上方式不同

$.ajax({
           url: "/api/student/poststudent",
           type: 'POST',
           data:'"name=张三,age=21"',//这里是重点！用单引号包一个双引号，双引号里为字符串内容！
           success:function () {
           },
           dataType: "json",
           contentType: "application/json"
       });
  1. 后台处理Post请求代码
[HttpPost("{id}")]
public void PostStudent([FromBody] string values)
{
}

WebApi 方法参数前加[FromBody]标识，表示该参数值应该从请求的Body中获取，而不是从URL中获取。不加[FromBody]标识后台取不到参数值。

4. 接收参数结果

在这里插入图片描述

设置允许跨域
如果有跨域需求支持，请设置允许跨域。在Startup.cs中添加如下代码。

  1. 修改ConfigureServices方法，添加代码如下：
//允许一个或多个来源可以跨域
services.AddCors(options =>
{
      options.AddPolicy("CustomCorsPolicy", policy =>
      {
             // 设定允许跨域的来源，有多个可以用','隔开
             policy.WithOrigins("https://localhost:5000")//只允许https://localhost:5000来源允许跨域
             .AllowAnyHeader()
             .AllowAnyMethod()
             .AllowCredentials();
      });
});
  1. 修改Configure方法，添加代码如下：
app.UseCors("CustomCorsPolicy");
.Net Core WebAPI参数的传递方式
俞祥胜的.Net进阶之旅
05-26 882
来获取，如果操作方法的参数名字和QueryString的名字一致，只需要为参数添加[FromQuery]，否则，就要设定[FromQuery]的name属性指定名字。GetAll方法添加了[HttpGet("schllo/{schoolName}/class/{classNo}")]需求：前端浏览器向服务器发送的报文体：{“name”:“qs”,“age”:“18”}请求路径/Student/GetAll/school/MIT/class/A001。而Web API项目选择。、请求报文体3种方式。
.NET Core WebApi第4讲：控制器、路由
weixin_54966200的博客
10-28 1097
在API里面，我们把每一个方法叫做action请求行为，把方法叫做行为（行为的英文是action）。为什么能把方法叫行为？——之前学类的时候，人吃喝拉撒睡、 跑步都是你这个人的一个行为。
asp.net core webapi项目配置全局路由的方法示例
10-17
主要介绍了asp.net core webapi项目配置全局路由的方法示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
asp.net core webapi项目配置全局路由
测试0901-1
09-20 1204
0、目录 整体架构目录：ASP.NET Core分布式项目实战-目录 一、前言 在开发项目的过程中，我新创建了一个controller，发现vs会给我们直接在controller头添加前缀，比如[Route("api/[controller]")],即在访问接口的时候会变成http://localhost:8000/api/values，但是如果...
ASP.NET Core Web API 参数传递方式
lei1083929965的博客
04-05 1634
在ASP.NET Core Web API中，参数传递方式多样且灵活，合理选择传递方式对API设计和性能优化至关重要。场景：处理特殊格式的输入（如自定义日期格式实现：继承接口。示例// 解析自定义日期格式...[HttpGet"events"typeof// 使用自定义日期绑定逻辑通过合理选择参数传递方式，结合验证和安全性措施，可以构建高效、安全且易维护的Web API。
ASP提高数据显示效率-缓存探幽
10-30
写在前面的话:此篇还是asp相关的,相信玩ASP的都有这个感觉,当数据有5万多条时-------just like音乐网,要调用最新的10条在页面显示,糟糕的是,当n多用户打开页面访问的时候,每个用户每次都要读取数据库一次,这无疑降低...
Hadoop现有测试框架探幽
03-02
从使用hadoop的第一天开始，就一直没有离开过对Hadoop自身功能的开发以及hadoop本身bug的修复的相关开发。这样的开发模式已经持续了好几年，但是可以从中发现的一个现象：对于我们修复的bug或者开发的功能，一直都...
暴强贴：从.NET平台调用Win32 API
水之真谛
12-20 1万+
作者：刘铁猛日期：2005-12-20关键字：C# .NET Win32 API版权声明:本文章受知识产权法保护，如果阁下想转载,在转载的时候烦劳阁下连同在下的姓名一起转载,并向bladey@tom.com发一个Mail,我很想知道我的文章都去哪里了.谢谢.小序        Win32 API可以直接控制Microsoft Windows的核心，因为API（Application Program
ASP.NET Core API 配置全局路由
KingCruel的专栏
04-12 6917
ASP.NET Core 中的路由在 ASP.NET Core 中路由到控制器操作ASP.NET Web API 2 中的属性路由文档目录 .NET 文档 ASP.NET 文档 ASP.NET Core默认使用的是属性路由，如下图 在Controller上标记形式为[Route("api")]，在Controller的action上标记形式为[Route("v1/[controller...
ASP.NET Core Web API入门之二：Swagger详细使用&路由设置
qq_40615333的博客
06-10 3040
本篇文章是Swagger的详细使用，续上篇[ASP.NET Core Web API入门之一：创建新项目](https://blog.csdn.net/qq_40615333/article/details/131130983?spm=1001.2014.3001.5501)。 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档。
.net core webapi post传递参数实战
qq_18932003的博客
08-28 1932
我希望有个如你一般的人，如山间清爽的风，如古城温暖的光，从清晨到夜晚，从山野到书房，只要最后是你就好 传递一个参数： 后台： [HttpPost] publicvoidPost([FromBody]stringvalue) { } 前台这样写会报错： $.ajax({ url:'http://localhost:8093/api/v1/test', type:"post", data:{"value":"sdfs...
.net core webapi post传递参数
极客神殿
08-08 2091
我希望有个如你一般的人，如山间清爽的风，如古城温暖的光，从清晨到夜晚，从山野到书房，只要最后是你就好 传递一个参数： 后台： [HttpPost] public void Post([FromBody] string value) { } 前台这样写会报错： $.ajax({ url: 'http://localhost:8093/api/v1/test', type: "post", data: { "value": "sdfsf" }, success: functi
Asp.net Core WebApi--(1)环境搭建
游响云停专栏
10-14 3618
随着微软对开源世界的拥抱，微软的编程语言也开始跨平台化了，以后使用.NET语言的小朋友们可以开发跨平台的程序了，妈妈再也不用为你的工作担心了.既然是开发跨平台程序，必然需要一个开发利器，VS2015便油然而生。下面我们来介绍并演示下使用vs2015开发跨平台系统。
.NetCore 如何动态路由
qq_36694046的博客
02-05 1786
.NetCore 如何动态路由
ASP.NET CORE WebAPI 中 Route 属性配置
热门推荐
DanielChen的博客
07-06 1万+
1 访问路径属性 Route public class OrdersController : ApiController { [Route("customers/{customerId}/orders")] [HttpGet] public IEnumerable<Order> FindOrdersByCustomer(int customerId) { ...
ASP.NET Core 动态路由与 ApiController 结合的实践
最新发布
m0_74337424的博客
06-02 523
首先，我们需要创建一个自定义的实现。这个提供者将在之前执行，以确保我们的自定义路由能够被应用。/// 确保在 ApiBehaviorApplicationModelProvider 之前执行。// 这里是我们的自定义逻辑。
asp.net core webapi 参数
q8812345qaz的博客
09-30 467
1.关于api参数 下面例子中 已经添加了详细的注释与说明。
.Net WebApi 中的 FromBody FromForm FromQuery FromHeader FromRoute
虚幻私塾
10-07 1620
当然，很多情况下这样写是不会报错的，因为我们需要的数据，往往只会存在于一个地方，就是请求体（body），而我们的 .Net Core 又足够的强大，导致本不严谨的操作却不会发生 bug。而当出现这样的一个需求的时候，小伙伴们思考一下应该怎么做：一个 Post 请求，参数分别放在了 地址栏（url?在日常后端Api开发中，我们跟前端的沟通中，通常需要协商好入参的数据类型，和参数是通过什么方式存在于请求中的，是表单（form）、请求体（body）、地址栏参数（query）、还是说通过请求头（header）。
Scala系列5：轻松搞定Scala中方法与函数的区别与使用
涤生大数据
09-01 1303
0.方法介绍 一个类可以有自己的方法， scala中的方法和Java方法类似。 但scala与Java定义方法的语法是不一样的， 而且scala支持多种调用方式。 1.定义方法 2.方法参数 *默认参数 *带名参数 *变长参数 3.方法返回值类型推断 4.方法调用方式 *后缀调用法 *中缀调用法 *花括号调用法 *无括号调用法 0.1.定义方法 定义方法的语法格式：
探幽入微LSTM
04-25
### LSTM 的深入原理 LSTM 是一种特殊的循环神经网络（RNN），其设计目的是解决传统 RNN 中存在的梯度消失和梯度爆炸问题，从而能够捕捉长时间序列中的依赖关系。LSTM 通过引入门控机制以及细胞状态的概念实现了这...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值