ASP.NET Web API 簡介
ASP.NET MVC 4 包含了 ASP.NET Web API， 這是一個建立可以連線包括瀏覽器、移動裝置等多種客戶端的 Http 服務的新框架， ASP.NET Web API 也是構建 RESTful 服務的理想平臺。
ASP.NET Web API 特性
ASP.NET Web API 包含下列特性：
- 先進的 HTTP 程式設計模型：使用新的強型別的 HTTP 物件模型直接操作 HTTP 請求和響應， 在 HTTP客戶端使用相同的程式設計模型和 HTTP 管道；
- 支援路由：Web API 完整支援 ASP.NET 路由， 包括路由引數和約束。 此外， 到動作的對映支援約定， 從此將不再需要向類或者方法新增類似於 [HttpPost] 之類的屬性；
- 內容協商：客戶端與服務端可以一起決定 API 返回資料的格式。 預設支援 XML， JSON 以及 Form URL-Encoded 格式， 可以擴充套件新增自定義格式， 甚至可以替換掉預設的內容協商策略；
- 模型繫結與驗證：模型繫結器可以輕易地從 HTTP 請求中提取資料並轉換成在動作方法中使用的 .Net 物件；
- 過濾：Web API 支援過濾， 包括總所周知的 [Authorize] 過濾標記， 可以為 Action 新增並插入自定義過濾， 實現認證、異常處理等；
- 查詢聚合：只要簡單的返回 Iqueryable<T> ， Web API 將會支援通過 OData 地址約定進行查詢；
- 改進的 Http 細節可測試性：Web API 不是將 HTTP 細節設定到一個靜態的 Context 物件上， 而是使用 HttpRequestMessage 和 HttpResponseMessage 例項， 可以使用這些物件的泛型版本為這些 Http 型別新增自定義型別；
- 改進的依賴反轉 (IoC) 支援：Web API 使用 MVC Dependency Resolver 實現的服務定位器模式在不同的場景下來獲取例項；
- 基於程式碼的配置：Web API 單獨使用程式碼完成配置， 從而保證了配置檔案的整潔；
- 自託管 (Self-Host) ：Web API 除了可以託管在 IIS 中， 還可以託管在程序中，依舊可以使用路由以及其它的特性。
第一個 Web API 程式
從零開始建立 Web API 專案
1、 建立一個空的 ASP.NET 4.0 網站專案
2、 新增對 System.Net.Http , System.Net.Http.Formatting , System.Web.Http , System.Web.Http.Common , System.Web.Http.WebHost 的引用
3、 新增 Global Application Class ， 並在 Global 類中的 Application_Start 方法中新增如下程式碼：
| 1 2 3 4 5 6 7 |
RouteTable.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{controller}/{id}",
defaults: new{
id = RouteParameter.Optional
}
);
|
4、新增一個 ProductsController ， 繼承自 ApiController ， 程式碼如下：
| 1 2 3 4 5 6 7 |
publicclassProductController : ApiController {
publicIQueryable<product> GetAllProducts() { ... }
publicProduct GetProductById(intid) { ... }
}</product>
|
5、 在瀏覽器輸入 URI 訪問資源， 也可以通過指令碼等任何客戶端進行訪問， 以瀏覽器為例：
在位址列輸入 http://localhost:64334/api/products 將會訪問到 GetAllProducts 方法， 返回所有的 Product 例項；
在位址列輸入 http://localhost:64334/api/products /1 將會訪問到 GetProductById 方法， 返回指定 id 的 Product 例項；
理解 API 路由
對於每一個 Http 訊息， ASP.NET Web API 框架通過路由表決定由哪個控制器處理請求。 當你建立一個新的 Web API 專案時， 將會包含一個類似這樣的一個預設的路由：
/api/{controller}/{id}
{controller} 和 {id} 是兩個佔位符， 當遇到一個符合這種樣式的 URI ， 將將會開始尋找合適的控制器方法進行呼叫， 規則如下：
- {controller} 用來與控制器名稱像匹配；
- HTTP 請求的方法用來與方法名稱匹配； （本規則只適用於 GET, POST, PUT 和 DELETE）
- {id} ， 如果有， 將會用於和方法的 id 引數進行匹配；
這裡有一些請求的例子， 以及基於當前實現情況的的 HTTP 動作結果：
| HTTP Method | URI | Action |
| GET | /api/products | GetAllProducts |
| GET | /api/products/5 | GetProduct(5) |
| POST | /api/products | HTTP Status 405 |
| GET | /api/users/ | HTTP Status 404 |
在第一個例子中， 與 "products" 相匹配的是 ProductsController ， HTTP 請求的方法是 GET ， 所以框架開始在 ProductController 類裡面尋找以 “Get” 開頭的方法， 此外， URI 中沒有提供 id 引數， 所以框架要找一個沒有引數的方法， 最後， ProductsController 的 GetAllProducts 方法滿足要求。
第二個例子與第一個類似， 不同的是 URI 裡面包含了 {id} 引數。 因此， 框架呼叫 GetProduct 方法， 因為它需要一個名稱為 id 引數。 值得注意的是， URI 裡面的 id 引數是字串型別的 “5” ， 框架會根據方法的簽名自動把它轉換成整形。
在第三個例子中， 客戶端發起 HTTP Post 請求， 框架尋找名稱以 “Post” 開始的方法。 而 ProductController 類沒有這樣的方法， 所以框架返回的 HTTP 狀態碼是 405 ， 表示不允許呼叫的方法 （Method Not Allowed） 。
再看第四個例子， 客戶端傳送一個 GET 請求到 /api/users 。 框架尋找名稱為 UserController 的控制器， 這樣的類還沒有定義， 所以框架返回的 HTTP 狀態碼是 404 ， 表示請求的資源未找到。
Web API CURD
什麼是 CURD
CURD 是指 Create 、 Update 、 Read 、 Delete 四個簡單的資料庫操作， 通常大多數 Web 服務也通過 REST 風格的服務提供這些操作。
接下來將繼續完善 ProductsController 以支援下面所有的操作：
|
動作 |
HTTP方法 |
相對路徑 |
|
獲取全部 |
GET |
/api/products |
|
指定id獲取 |
GET |
/api/products/id |
|
新增 |
POST |
/api/products |
|
更新 |
PUT |
/api/products/id |
|
刪除 |
DELETE |
/api/products/id |
資源
ProductController 提供了兩種 URI 資源：
|
資源 |
地址 |
|
全部產品列表 |
/api/products |
|
單個產品 |
/api/products/id |
HTTP 的四個主要方法 （GET， PUT， POST， DELETE） 按照下列方式對映為 CURD 操作：
- GET 用於獲取 URI 資源的進行展示， GET 操作不應對服務端有任何影響；
- PUT 用於更新 URI 上的一個資源， 如果服務端允許， PUT 也可以用於新建一個資源；
- POST 用於新建 資源， 服務端在指定的 URI 上建立一個新的物件， 將新資源的地址作為響應訊息的一部分返回；
- DELETE 用於刪除指定的 URI 資源。
實現 CURD
新建資源
客戶端發起 HTTP POST 請求新建資源， 為了能處理 POST 請求， 需要在 ProductController 定義一個以 Post 開頭的方法， 這個方法接受一個型別為 Product 的引數。
根據 HTTP/1.1 協議， 需要注意的問題有：
- 響應程式碼： Web API 預設返回的響應程式碼是 200 (OK) ， 但是根據 HTTP/1.1 協議， POST 請求並建立資源的響應程式碼應該是 201 (Created)；
- 地址： 當伺服器建立資源之後， 應該在響應的 Header 裡面包含新資源的地址。
新建資源的最終程式碼如下：
| 1 2 3 4 5 6 7 |
publicHttpResponseMessage<product> PostProduct(Product product) {
this._dbContext.Save(product);
varresult = newHttpResponseMessage<product>(product, HttpStatusCode.Created);
varlocation = Url.Route(null, new{ id = product.ProductID });
result.Headers.Location = newUri(location);
returnresult;
}</product></product>
|
更新資源內容
更新是比較簡單的， 程式碼如下：
| 1 2 3 4 5 6 7 8 |
publicHttpResponseMessage PutProduct(intid, Product product) {
if(!this._dbContext.Products.Any(p => p.ProductID == id)) {
thrownewHttpResponseException(HttpStatusCode.NotFound);
}
product.ProductID = id;
this._dbContext.Update(product);
returnnewHttpResponseMessage(HttpStatusCode.OK);
}
|
該方法需要兩個引數， id 從 URI 中獲取， product 從客戶端請求訊息中獲取。
刪除資源
根據 HTTP 協議， 刪除應當是冪等的， 也就是說一個 URI 上接受到多少個刪除請求都是相同的， 如果資源已經被刪除， 也不能返回錯誤的響應程式碼。
如果成功刪除了資源， 可以返回 200 (OK) 響應程式碼， 以及一個實體進行狀態說明， 或者返回 204 (No Content)。
如果刪除需要等待事務完成， 則應該返回 202 (Accepted) 。
刪除資源的實現程式碼如下：
| 1 2 3 4 5 |
publicHttpResponseMessage DeleteProduct(intid) {
varproduct = this._dbContext.Products.FirstOrDefault(p => p.ProductID == id);
this._dbContext.Delete(product);
returnnewHttpResponseMessage(HttpStatusCode.NoContent);
}
|