.NET WebAPI 基础 FromRoute、FromQuery、FromBody 用法-Toy模板网

这篇具有很好参考价值的文章主要介绍了.NET WebAPI 基础 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；还需要建一个接收参数的实体类，当然也可以不使用实体类，个人建议是使用；

实体类

public class Parameter
{
    public string? Method { get; set; }

    public string? Value { get; set; }
}

Url 传参

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

示例

.NET WebAPI 基础 FromRoute、FromQuery、FromBody 用法

Route 传参

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

示例

.NET WebAPI 基础 FromRoute、FromQuery、FromBody 用法

Body传参

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

示例

.NET WebAPI 基础 FromRoute、FromQuery、FromBody 用法

混合

[HttpPatch("{method}/{value}")]
public async Task<Dictionary<string, Parameter>> PatchAsync(
    [FromRoute] Parameter route,
    [FromQuery] Parameter query,
    [FromBody] Parameter body)
{
    var result = new Dictionary<string, Parameter>()
    {
        ["route"] = route,
        ["query"] = query,
        ["body"] = body
    };

    return await Task.FromResult(result);
}