在ASP.NET Core Web API中，接收客戶端傳遞的參數是開發RESTful API的關鍵環節。本文將詳細介紹ASP.NET Core中接收參數的多種方式，並透過範例程式碼來具體展示如何實作。
一、參數的型別與格式
在ASP.NET Core中，客戶端可以透過多種方式向伺服器傳遞參數，這些參數可以是簡單型別（如整數、字串），也可以是復雜型別（如物件、陣列）。參數的格式通常取決於客戶端請求的內容型別（Content-Type），常見的格式包括
application/json
、
application/x-www-form-urlencoded
和
multipart/form-data
。
二、常見的參數接收方式
從查詢字串中獲取參數
當參數作為URL的一部份傳遞時，我們通常從查詢字串中獲取它們。這種方式適用於GET請求，並且參數數量不多的情況。
[HttpGet]
public IActionResult Get([FromQuery] string param1, int param2)
{
// 處理參數
return Ok();
}優點：簡單直接，易於理解和實作。
缺點：不適合傳遞大量或復雜的數據，因為URL長度有限制。
從請求體中獲取參數
對於POST、PUT等請求，參數通常放在請求體中傳遞。ASP.NET Core可以自動將請求體中的JSON或表單數據反序列化為方法參數中的物件。
[HttpPost]
public IActionResult Post([FromBody] MyModel model)
{
// 處理模型數據
return Ok();
}優點：可以傳遞復雜的數據結構，適用於需要送出大量數據的情況。
缺點：相對於查詢字串方式，實作稍微復雜一些。
從路由中獲取參數
在定義路由時，可以將某些參數作為URL的一部份來捕獲。
[HttpGet("{id}")]
public IActionResult Get(int id)
{
// 根據ID處理數據
return Ok();
}優點：URL結構清晰，便於RESTful API的設計。
缺點：同樣不適合傳遞大量數據。
從請求頭中獲取參數
有時，某些資訊可能透過HTTP頭傳遞，如認證令牌等。
[HttpGet]
public IActionResult Get([FromHeader] string authorization)
{
// 驗證和處理授權資訊
return Ok();
}優點：適用於傳遞一些關鍵的、少量的、不需要經常變化的資訊。
缺點：不適合傳遞大量數據，且不是所有的資訊都適合放在頭資訊中傳遞。
三、註意事項和最佳實踐
當使用
[FromBody]
特性時，一個Action中只能有一個參數使用此特性，因為請求體只能被讀取一次。
對於簡單的、少量的數據，可以使用查詢字串或路由參數傳遞。
對於復雜的、大量的數據，最好使用請求體傳遞，並確保Content-Type設定正確。
在接收參數時，要確保數據型別和格式與客戶端發送的數據匹配，否則可能會導致數據解析失敗。
始終驗證和清理從客戶端接收的數據，以防止安全漏洞，如SQL註入等。
在設計API時，要遵循RESTful原則，確保API的清晰性和一致性。
透過了解和掌握ASP.NET Core中的參數接收方式，開發人員可以更加靈活地設計和實作Web API，從而提供更好的使用者體驗和服務品質。
