一文讀懂.NET WebAPI中FromRoute、FromQuery、FromBody的關鍵角色與用法

来源:https://www.cnblogs.com/xbhp/p/18137844
-Advertisement-
Play Games

.NET WebAPI作為一種構建RESTful服務的強大工具,為開發者提供了便捷的方式來定義、處理HTTP請求並返迴響應。在設計API介面時,正確地接收和解析客戶端發送的數據至關重要。.NET WebAPI提供了一系列特性,如[FromRoute]、[FromQuery]和[FromBody],用 ...


.NET WebAPI作為一種構建RESTful服務的強大工具,為開發者提供了便捷的方式來定義、處理HTTP請求並返迴響應。在設計API介面時,正確地接收和解析客戶端發送的數據至關重要。.NET WebAPI提供了一系列特性,如[FromRoute][FromQuery][FromBody],用於指示控制器方法應如何從不同的請求源提取參數。本文將深入探討這三個屬性的作用及其用法。

一、[FromRoute]:從路由模板提取參數

作用:[FromRoute]屬性用於標識那些應從HTTP請求的路由數據中提取的參數。當客戶端訪問一個URL,其路徑部分可能包含動態占位符(通常稱為路由參數)。[FromRoute]屬性指示ASP.NET Core框架應將這些路由參數值綁定到控制器方法的相應參數上。

用法:假設我們有一個路由模板api/users/{userId},其中{userId}是動態部分。對應的控制器方法可以這樣聲明:

[HttpGet("api/users/{userId}")]
public IActionResult GetUser([FromRoute]int userId)
{
    // 使用 userId 參數查詢用戶信息並返回結果
}

在上述代碼中,userId參數被[FromRoute]裝飾,表示它應從請求的URL路徑(即路由數據)中獲取其值。當客戶端訪問如https://example.com/api/users/123這樣的URL時,userId參數會被自動賦值為123

二、[FromQuery]:從查詢字元串提取參數

作用:[FromQuery]屬性指示控制器方法應從HTTP請求的查詢字元串中提取參數。查詢字元串是URL末尾以問號(?)開始,由鍵值對組成的部分,例如?sortOrder=asc&page=2。使用[FromQuery],可以輕鬆地將這些鍵值對映射到方法參數。

用法:考慮一個API端點用於分頁和排序用戶列表,其URL可能包含查詢參數:

[HttpGet("api/users")]
public IActionResult GetUsers([FromQuery]string sortOrder = "desc", [FromQuery]int page = 1, [FromQuery]int pageSize = 20)
{
    // 使用 sortOrder, page, pageSize 參數執行查詢並返回結果
}

在這個例子中,sortOrderpagepageSize參數都標記為[FromQuery],表示它們的值應從請求的查詢字元串中提取。客戶端可以通過訪問類似https://example.com/api/users?sortOrder=asc&page=2的URL來指定排序方式和分頁信息。

三、[FromBody]:從請求主體(Body)提取參數

作用:[FromBody]屬性指示ASP.NET Core框架應從HTTP請求的主體(Body)中反序列化並提取參數。這通常用於處理POSTPUT等方法中攜帶的複雜數據,如JSON或XML格式的內容。當客戶端以請求體的形式發送非簡單類型的數據時,[FromBody]是必不可少的。

用法:假設我們有一個API端點用於創建新用戶,客戶端以JSON格式將用戶信息發送到伺服器:

[HttpPost("api/users")]
public IActionResult CreateUser([FromBody]User user)
{
    // 使用 user 參數創建新用戶並返回結果
}

public class User
{
    public string Username { get; set; }
    public string Password { get; set; }
   public string Notes { get; set; }
}

在此示例中,User類實例作為CreateUser方法的參數,並用[FromBody]修飾。當客戶端發送如下JSON到POST /api/users

{
    "username": "DotNET開發跳槽",
    "password": "s3cr3tP@ssw0rd"
    "Notes": "歡迎關註公眾號:DotNET開發跳槽;加微信xbhpnet入群求職技術交流",
}

ASP.NET Core會自動將JSON內容反序列化為User對象,並將其賦值給user參數。

結語

[FromRoute][FromQuery][FromBody]是.NET WebAPI中用於從不同請求源提取參數的核心特性。本文介紹了三者在.NET WebAPI中的角色和用法,希望給大家帶來收穫。

當然也可以不添加這些特性,若不使用[FromRoute]、[FromQuery]和[FromBody]等特性來明確指示參數來源,ASP.NET Core WebAPI會遵循預設綁定規則嘗試自動綁定請求數據。雖然這種方式在簡單場景下可能工作,但它可能導致代碼可讀性降低、綁定行為不確定性增加以及限制API設計的靈活性與可擴展性。因此,為了確保代碼清晰、易於理解和維護,以及請求數據綁定的確定性和一致性,建議在編寫控制器方法時始終顯式使用這些特性指定參數來源。

理解並恰當使用這些屬性,能夠確保您的WebAPI介面準確、高效地處理客戶端請求,實現清晰、語義化的API設計。根據請求數據的位置和格式,選擇合適的屬性進行參數綁定,是構建健壯、通用RESTful API的關鍵步驟之一。本文僅供參考。

來源公眾號↑↑↑:DotNet開發跳槽❀    

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 民爆生產廠區有地面站和民爆車,現場地面站的控制系統為西門子PLC和歐姆龍PLC,民爆車為三菱PLC,地面站通過光纖與本地機房進行數據交互,民爆車的位置及其他數據通過4G與本地機房進行數據交互。本地機房與北京運維中心進行數據交互,實現民爆行業的綜合運維平臺。 ...
  • 一、前言 在項目開發過程中,DataGrid是經常使用到的一個數據展示控制項,而通常表格的最後一列是作為操作列存在,比如會有編輯、刪除等功能按鈕。但WPF的原始DataGrid中,預設只支持固定左側列,這跟大家習慣性操作列放最後不符,今天就來介紹一種簡單的方式實現固定右側列。(這裡的實現方式參考的大佬 ...
  • 前言 .NET生態中有許多依賴註入容器。在大多數情況下,微軟提供的內置容器在易用性和性能方面都非常優秀。外加ASP.NET Core預設使用內置容器,使用很方便。 但是筆者在使用中一直有一個頭疼的問題:服務工廠無法提供請求的服務類型相關的信息。這在一般情況下並沒有影響,但是內置容器支持註冊開放泛型服 ...
  • 一:背景 1. 講故事 上個月有個朋友在微信上找到我,說他們的軟體在客戶那邊隔幾天就要崩潰一次,一直都沒有找到原因,讓我幫忙看下怎麼回事,確實工控類的軟體環境複雜難搞,朋友手上有一個崩潰的dump,剛好丟給我來分析一下。 二:WinDbg分析 1. 程式為什麼會崩潰 windbg 有一個厲害之處在於 ...
  • 如果你在自定義的 Main 方法中直接使用 App 類並啟動應用程式,但發現 App.xaml 中定義的資源沒有被正確載入,那麼問題可能在於如何正確配置 App.xaml 與你的 App 類的交互。 確保 App.xaml 文件中的 x:Class 屬性正確指向你的 App 類。這樣,當你創建 Ap ...
  • 一、前言 在自己的項目中,涉及到實時心率曲線的繪製,項目上的曲線繪製,一般很難找到能直接用的第三方庫,而且有些還是定製化的功能,所以還是自己繪製比較方便。很多人一聽到自己畫就害怕,感覺很難,今天就分享一個完整的實時心率數據繪製心率曲線圖的例子;之前的博客也分享給DrawingVisual繪製曲線的方 ...
  • 引言 上一章我們介紹了在xUnit單元測試中用xUnit.DependencyInject來使用依賴註入,上一章我們的Sample.Repository倉儲層有一個批量註入的介面沒有做單元測試,今天用這個示例來演示一下如何用Bogus創建模擬數據 ,和 EFCore 的種子數據生成 Bogus 的優 ...
  • 原因:我之所以想做這個項目,是因為在之前查找關於C#/WPF相關資料時,我發現講解圖像濾鏡的資源非常稀缺。此外,我註意到許多現有的開源庫主要基於CPU進行圖像渲染。這種方式在處理大量圖像時,會導致CPU的渲染負擔過重。因此,我將在下文中介紹如何通過GPU渲染來有效實現圖像的各種濾鏡效果。 生成的效果 ...
一周排行
    -Advertisement-
    Play Games
  • 不廢話,直接代碼 private Stack<Action> actionStack = new Stack<Action>(); private void SetCellValues() { var worksheet = Globals.ThisAddIn.Application.ActiveS ...
  • OpenAPI 規範是用於描述 HTTP API 的標準。該標準允許開發人員定義 API 的形狀,這些 API 可以插入到客戶端生成器、伺服器生成器、測試工具、文檔等中。儘管該標準具有普遍性和普遍性,但 ASP.NET Core 在框架內預設不提供對 OpenAPI 的支持。 當前 ASP.NET ...
  • @DateTimeFormat 和 @JsonFormat 是 Spring 和 Jackson 中用於處理日期時間格式的註解,它們有不同的作用: @DateTimeFormat @DateTimeFormat 是 Spring 框架提供的註解,用於指定字元串如何轉換為日期時間類型,以及如何格式化日 ...
  • 一、背景說明 1.1 效果演示 用python開發的爬蟲採集軟體,可自動抓取抖音評論數據,並且含二級評論! 為什麼有了源碼還開發界面軟體呢?方便不懂編程代碼的小白用戶使用,無需安裝python、無需懂代碼,雙擊打開即用! 軟體界面截圖: 爬取結果截圖: 以上。 1.2 演示視頻 軟體運行演示視頻:見 ...
  • SpringBoot筆記 SpringBoot文檔 官網: https://spring.io/projects/spring-boot 學習文檔: https://docs.spring.io/spring-boot/docs/current/reference/html/ 線上API: http ...
  • 作為後端工程師,多數情況都是給別人提供介面,寫的好不好使你得重視起來。 最近我手頭一些活,需要和外部公司對接,我們需要提供一個介面文檔,這樣可以節省雙方時間、也可以防止後續扯皮。這是就要考驗我的介面是否規範化。 1. 介面名稱清晰、明確 顧名思義,介面是做什麼的,是否準確、清晰?讓使用這一眼就能知道 ...
  • 本文介紹基於Python語言,遍歷文件夾並從中找到文件名稱符合我們需求的多個.txt格式文本文件,並從上述每一個文本文件中,找到我們需要的指定數據,最後得到所有文本文件中我們需要的數據的合集的方法~ ...
  • Java JUC&多線程 基礎完整版 目錄Java JUC&多線程 基礎完整版1、 多線程的第一種啟動方式之繼承Thread類2、多線程的第二種啟動方式之實現Runnable介面3、多線程的第三種實現方式之實現Callable介面4、多線的常用成員方法5、線程的優先順序6、守護線程7、線程的讓出8、線 ...
  • 實時識別關鍵詞是一種能夠將搜索結果提升至新的高度的API介面。它可以幫助我們更有效地分析文本,並提取出關鍵詞,以便進行進一步的處理和分析。 該介面是挖數據平臺提供的,有三種模式:精確模式、全模式和搜索引擎模式。不同的模式在分詞的方式上有所不同,適用於不同的場景。 首先是精確模式。這種模式會儘量將句子 ...
  • 1 為啥要折騰搭建一個專屬圖床? 技術大佬寫博客都用 md 格式,要在多平臺發佈,圖片就得有外鏈 後續如博客遷移,國內博客網站如掘金,簡書,語雀等都做了防盜鏈,圖片無法遷移 2 為啥選擇CloudFlare R2 跳轉:https://dash.cloudflare.com/ 有白嫖額度 免費 CD ...