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

2023-08-29 06:01:46

原文連結: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);
}

範例

Route 傳參

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

範例

Body傳參

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

範例

 混合

[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);
}

範例

   寫得不好,手生了,大家有什麼想了解的歡迎在評論區留言,我也需要多練練手【手動狗頭】,什麼時候部落格園可以加個表情功能啊!