.NET API 中的 FromRoute、FromQuery、FromBody 用法

猫头洋

原文链接：https://www.cnblogs.com/ysmc/p/17663663.html
　　最近技术交流群里，还有不少小伙伴不知道 FromRoute、FromQuery、FromBody 这几个特性是怎么使用的，也不清楚它们之间的区别在哪里，特意写下这个文章，希望可以帮助到迷茫的小伙伴。
在API开发过程中，我们先要确定我们的接口是干嘛的，获取请求数据用 GET，上传使用 POST，修改使用 PATCH，删除是 DELETE，通常使用这4个就足够了。
　　接着下一步，就是参数放在哪了，通常：
　　（1）GET请求的参数，是以url?xxx=value1&xxx=value 这样的方式进行传参；
　　（2）POST、PATCH，则是放在 body里，当然也可以放在form中；
　　（3）而所有的请求方式，都是支持通过 url 传参的，包括通过 route 传参；
　　好久没写文档了，都不知道怎么写了，还是直接上代码吧；
　　我们新建一个API工程，过程我就不演示了；建一个Controller，我这里起名为 MethodsController；还需要建一个接收参数的实体类，当然也可以不使用实体类，个人建议是使用；
实体类

1. public class Parameter
2. {
3.     public string? Method { get; set; }
5.     public string? Value { get; set; }
6. }

复制代码

Url 传参

1. [HttpGet]
2. public async Task<Parameter> GetQueryAsync([FromQuery] Parameter query)
3. {
4.     return await Task.FromResult(query);
5. }

复制代码

示例

Route 传参

1. [HttpGet("{method}/{value}")]
2. public async Task<Parameter> GetRouteAsync([FromRoute] Parameter route)
3. {
4.     return await Task.FromResult(route);
5. }

复制代码

示例

Body传参

1. [HttpPost]
2. public async Task<Parameter> PostAsync([FromBody] Parameter body)
3. {
4.     return await Task.FromResult(body);
5. }

复制代码

示例

 混合

1. [HttpPatch("{method}/{value}")]
2. public async Task<Dictionary<string, Parameter>> PatchAsync(
3.     [FromRoute] Parameter route,
4.     [FromQuery] Parameter query,
5.     [FromBody] Parameter body)
6. {
7.     var result = new Dictionary<string, Parameter>()
8.     {
9.         ["route"] = route,
10.         ["query"] = query,
11.         ["body"] = body
12.     };
14.     return await Task.FromResult(result);
15. }

复制代码

示例

 　　写得不好，手生了，大家有什么想了解的欢迎在评论区留言，我也需要多练练手【手动狗头】，什么时候博客园可以加个表情功能啊！

来源:https://www.cnblogs.com/ysmc/archive/2023/08/28/17663663.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！