教你如何構建簡單Web API

作者：shanyou 2011-09-16 14:21:47

開發后端

這個入門文章主要演示在ASP.NET MVC3網站宿主，讓各位.NET程序員知道如何構建簡單Web API。

　　WCF Web API支持多個宿主環境：自宿主（windows服務或者控制臺）和IIS宿主（ASP.NET webform/mvc）。這個入門文章主要演示在ASP.NET MVC3網站宿主：

　　如何使用NuGet向項目中添加Web Api引用

　　如何創建一個通過HTTP GET訪問的Web Api

　　如何通過ASP.NET routes宿主一個Web Api

　　如何通過瀏覽器或者Fiddler訪問Web Api

　　如何在Api上啟用OData uri查詢

　　1、創建一個基本的解決方案：使用VS2010新建一個空的ASP.NET MVC 3 Web Application

設置站點的端口號為9000

2、向解決方案中加入Web Api的引用

　　通過NuGet來添加Web api的程序集引用，右擊項目屬性，選擇“Manage NuGet Packages”

在NuGet管理擴展器上查詢Online的”webapi.all“

選擇安裝，NuGet就會下載所有所需的軟件包，現在可以開始開發Web Api。

　　3、創建一個Contacts Api類

　　右擊項目ContactManager選擇添加一個文件夾，取名”APIs“，然后在APIs文件夾上右擊添加類，類名叫做ContactsApi：

　　usingSystem.ServiceModel;  
　　namespaceContactManager.APIs  
　　{  
　　[ServiceContract]  
　　publicclassContactsApi  
　　{  
　　}  
　　}

　　ContractsApi 加了ServiceContractAttribute表示這是一個WCF 服務，將通過HTTP方式暴露出來。

　　4、通過ASP.NET routing注冊ContractsApi

　　Api需要通過ASP.NET mvc宿主，使用ASP.net Route的MapServiceRoute擴展方法把它注冊進去。切換到global.asax.cs文件，添加以下引用

　　usingContactManager.APIs;

　　usingMicrosoft.ApplicationServer.Http.Activation;

　　在RegisterRoutes方法里加入下述代碼

　　routes.MapServiceRoute<ContactsApi>("api/contacts");

　　下面的黃色部分很重要，MVC的默認路由是映射到controller + action

　　publicstaticvoidRegisterRoutes(RouteCollection routes)  
　　{  
　　routes.IgnoreRoute("{resource}.axd/{*pathInfo}");  
　　routes.MapServiceRoute<ContactsApi>("api/contacts");routes.MapRoute(  
　　"Default", // Route name  
　　"{controller}/{action}/{id}", // URL with parameters  
　　new{ controller = "Home", action = "Index", id = UrlParameter.Optional } // Parameter defaults  
　　);  
　　}

　　MapServiceRoute需要一個泛型參數指定服務（API），以及一個將被追加到IIS base url的路徑。在這里，我們指定的“contacts”，也就是宿主為“http://localhost:9000/api/contacts”。

　　5. 通過一個HTTP Get 方法暴露contacts：首先創建一個poco（Plain Old C#）Contract類，代表我們在api上傳遞的聯系人，本質上就是一個DTO（數據傳輸對象），在HTTP上我們把它作為資源，然后創建一個HTTP Get方法暴露資源。

　　右擊項目ContactManager項目選擇添加新的文件夾“Resources”，在Resources文件下創建一個新的類Contact。

　　namespaceContactManager.Resources  
　　{  
　　publicclassContact  
　　{  
　　publicintContactId { get; set; }  
　　publicstringName { get; set; }  
　　}  
　　}

　　返回到ContactApi類，添加下述引用：

　　usingSystem.ServiceModel.Web;  
　　usingContactManager.Resources;

　　添加一個Get方法返回所有的contracts

　　[WebGet(UriTemplate = "")]  
　　publicIQueryable<Contact> Get()  
　　{  
　　var contacts = newList<Contact>()  
　　{  
　　newContact {ContactId = 1, Name = "Phil Haack"},  
　　newContact {ContactId = 2, Name = "HongMei Ge"},  
　　newContact {ContactId = 3, Name = "Glenn Block"},  
　　newContact {ContactId = 4, Name = "Howard Dierking"},  
　　newContact {ContactId = 5, Name = "Jeff Handley"},  
　　newContact {ContactId = 6, Name = "Yavor Georgiev"}  
　　};  
　　returncontacts.AsQueryable();  
　}

　　Get方法上加了WebGet Attribute表示這是一個HTTP Get。注意這里的UriTemplate被設置為“”，默認情況下，操作的Uri是方法名Get，在這種情況下，我們是在Route中設置的Uri。

　　6、通過瀏覽器查詢Contracts.按F5運行項目，然后再瀏覽器地址欄中輸入http://localhost:9000/api/contacts

　　7、查詢返回Json格式的Contracts。HTTP提供了一些“內容協商”機制 — 當有多個可得的表現形式的時候，對特定的響應選擇最好的表現形式的處理過程。

　　服務器驅動協商（Server-driven Negotiation）

　　如果響應的最好的表現形式的選擇是通過服務器上的算法來實現，那么這種方式的協商稱做服務器驅動協商。選擇是基于響應可得的表現形式（根據不同的維度，響應會不同；例如，語言，內容編碼，等等）和請求消息里特定的頭域或關于請求的其他信息（如：網絡客戶端的地址）。

　　服務器驅動協商是有優點的，當從可行的表現形式里進行選擇的算法對用戶代理進行描述是比較困難的時候，或者當服務器期望發送“最好的猜測”給客戶端而只通過一個響應（以避免后續請求的回路（一個請求會返回一個響應）延遲如果此“最好的猜測“對用戶適合的時候）的時候。為了改善服務器的猜測，用戶代理應該包含請求頭域（Accept，Accept-Language，Accept-Encoding，等等），這些頭域能描述它對響應的喜好。

　　Web api返回的響應很容易添加一種媒體類型（media types )。

　　打開Fiddler，在“Request builder”欄輸入地址“http://localhost:9000/api/contacts”，然后移動到“Request Headers”在“User-Agent” 項下方添加 “Accept: application/json”