向Web API傳遞參數

數據可以通過多種方式來傳給API。 

Binding Source Attributes 會告訴 Model 的綁定引擎從哪裡找到綁定源。 

共有以下六種 Binding Source Attributes： 

• [FromBody] 

  • 請求的 Body 

• [FromForm] 

  • 請求的 Body 中的 form數據 

• [FromHeader] 

  • 請求的 Header 

• [FromQuery] 

  • Query string 參數 

• [FromRoute] 

  • 當前請求中的路由數據 

• [FromService] 

  • 作為 Action 參數而註入的服務 

例如： 

或: 

預設情況下ASP.NET Core 會使用 Complex Object Model Binder，它會把數據從Value Providers那裡提取出來，而Value Providers的順序是定義好的。 

但是我們構建API時通常會使用 [ApiController] 這個屬性，為了更好的適應API它改變了上面的規則。更改後的規則如下： 

• [FromBody] 

  • 通常是用來推斷複雜類型參數的。 

• [FromForm] 

  • 通常用來推斷IFormFile和IFormFileCollection類型的Action參數。 

• [FromRoute] 

  • 用來推斷Action的參數名和路由模板中的參數名一致的情況。 

• [FromQuery] 

  • 用來推斷其它的Action參數。 

   

按照這些規則，在Action的參數前面使用這些屬性，就可以避免讓我們手動去尋找綁定源。當預設的行為規則需要被重寫的時候，也可以使用這些 Binding Source Attributes。 

過濾

過濾集合的意思就是指根據條件限定返回的集合。 

例如我想返回所有類型為國有企業的歐洲公司。則URI為：GET /api/companies?type=State-owned&region=Europe 

所以過濾就是指：我們把某個欄位的名字以及想要讓該欄位匹配的值一起傳遞給API，並將這些作為返回的集合的一部分。 

搜索 

針對集合進行搜索是指根據預定義的一些規則，把符合條件的數據添加到集合裡面。 

搜索實際上超出了過濾的範圍。針對搜索，通常不會把要匹配的欄位名傳遞過去，通常會把要搜索的值傳遞給API，然後API自行決定應該對哪些欄位來查找該值。經常會是全文搜索。 

例如：GET /api/companies?q=xxx 

過濾 vs 搜索 

可以看出來過濾和搜索是不同的。 

過濾：首先是一個完整的集合，然後根據條件把匹配/不匹配的數據項移除。 

搜索：首先是一個空的集合，然後根據條件把匹配/不匹配的數據項往裡面添加。 

但需要註意的是： 

過濾和搜索這些參數並不是資源的一部分。 

只允許針對資源的欄位進行過濾。