教你如何構(gòu)建簡(jiǎn)單Web API
WCF Web API支持多個(gè)宿主環(huán)境：自宿主（windows服務(wù)或者控制臺(tái)）和IIS宿主（ASP.NET webform/mvc）。這個(gè)入門文章主要演示在ASP.NET MVC3網(wǎng)站宿主：
如何使用NuGet向項(xiàng)目中添加Web Api引用
如何創(chuàng)建一個(gè)通過(guò)HTTP GET訪問(wèn)的Web Api
如何通過(guò)ASP.NET routes宿主一個(gè)Web Api
如何通過(guò)瀏覽器或者Fiddler訪問(wèn)Web Api
如何在Api上啟用OData uri查詢
1、創(chuàng)建一個(gè)基本的解決方案：使用VS2010新建一個(gè)空的ASP.NET MVC 3 Web Application
設(shè)置站點(diǎn)的端口號(hào)為9000
2、向解決方案中加入Web Api的引用
通過(guò)NuGet來(lái)添加Web api的程序集引用，右擊項(xiàng)目屬性，選擇“Manage NuGet Packages”
在NuGet管理擴(kuò)展器上查詢Online的”webapi.all“
選擇安裝，NuGet就會(huì)下載所有所需的軟件包，現(xiàn)在可以開(kāi)始開(kāi)發(fā)Web Api。
3、創(chuàng)建一個(gè)Contacts Api類
右擊項(xiàng)目ContactManager選擇添加一個(gè)文件夾，取名”APIs“，然后在APIs文件夾上右擊添加類，類名叫做ContactsApi：
- usingSystem.ServiceModel;
- namespaceContactManager.APIs
- {
- [ServiceContract]
- publicclassContactsApi
- {
- }
- }
ContractsApi 加了ServiceContractAttribute表示這是一個(gè)WCF 服務(wù)，將通過(guò)HTTP方式暴露出來(lái)。
4、通過(guò)ASP.NET routing注冊(cè)ContractsApi
Api需要通過(guò)ASP.NET mvc宿主，使用ASP.net Route的MapServiceRoute擴(kuò)展方法把它注冊(cè)進(jìn)去。切換到global.asax.cs文件，添加以下引用
usingContactManager.APIs;
usingMicrosoft.ApplicationServer.Http.Activation;
在RegisterRoutes方法里加入下述代碼
routes.MapServiceRoute<ContactsApi>("api/contacts");
下面的黃色部分很重要，MVC的默認(rèn)路由是映射到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需要一個(gè)泛型參數(shù)指定服務(wù)（API），以及一個(gè)將被追加到IIS base url的路徑。在這里，我們指定的“contacts”，也就是宿主為“http://localhost:9000/api/contacts”。
5. 通過(guò)一個(gè)HTTP Get 方法暴露contacts：首先創(chuàng)建一個(gè)poco（Plain Old C#）Contract類，代表我們?cè)赼pi上傳遞的聯(lián)系人，本質(zhì)上就是一個(gè)DTO（數(shù)據(jù)傳輸對(duì)象），在HTTP上我們把它作為資源，然后創(chuàng)建一個(gè)HTTP Get方法暴露資源。
右擊項(xiàng)目ContactManager項(xiàng)目選擇添加新的文件夾“Resources”，在Resources文件下創(chuàng)建一個(gè)新的類Contact。
- namespaceContactManager.Resources
- {
- publicclassContact
- {
- publicintContactId { get; set; }
- publicstringName { get; set; }
- }
- }
返回到ContactApi類，添加下述引用：
- usingSystem.ServiceModel.Web;
- usingContactManager.Resources;
添加一個(gè)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表示這是一個(gè)HTTP Get。注意這里的UriTemplate被設(shè)置為“”，默認(rèn)情況下，操作的Uri是方法名Get，在這種情況下，我們是在Route中設(shè)置的Uri。
6、通過(guò)瀏覽器查詢Contracts.按F5運(yùn)行項(xiàng)目，然后再瀏覽器地址欄中輸入http://localhost:9000/api/contacts
7、查詢返回Json格式的Contracts。HTTP提供了一些“內(nèi)容協(xié)商”機(jī)制 — 當(dāng)有多個(gè)可得的表現(xiàn)形式的時(shí)候，對(duì)特定的響應(yīng)選擇最好的表現(xiàn)形式的處理過(guò)程。
服務(wù)器驅(qū)動(dòng)協(xié)商（Server-driven Negotiation）
如果響應(yīng)的最好的表現(xiàn)形式的選擇是通過(guò)服務(wù)器上的算法來(lái)實(shí)現(xiàn)，那么這種方式的協(xié)商稱做服務(wù)器驅(qū)動(dòng)協(xié)商。選擇是基于響應(yīng)可得的表現(xiàn)形式（根據(jù)不同的維度，響應(yīng)會(huì)不同；例如，語(yǔ)言，內(nèi)容編碼，等等）和請(qǐng)求消息里特定的頭域或關(guān)于請(qǐng)求的其他信息（如：網(wǎng)絡(luò)客戶端的地址）。
服務(wù)器驅(qū)動(dòng)協(xié)商是有優(yōu)點(diǎn)的，當(dāng)從可行的表現(xiàn)形式里進(jìn)行選擇的算法對(duì)用戶代理進(jìn)行描述是比較困難的時(shí)候，或者當(dāng)服務(wù)器期望發(fā)送“最好的猜測(cè)”給客戶端而只通過(guò)一個(gè)響應(yīng)（以避免后續(xù)請(qǐng)求的回路（一個(gè)請(qǐng)求會(huì)返回一個(gè)響應(yīng)）延遲如果此“最好的猜測(cè)“對(duì)用戶適合的時(shí)候）的時(shí)候。為了改善服務(wù)器的猜測(cè)，用戶代理應(yīng)該包含請(qǐng)求頭域（Accept，Accept-Language，Accept-Encoding，等等），這些頭域能描述它對(duì)響應(yīng)的喜好。
Web api返回的響應(yīng)很容易添加一種媒體類型（media types )。
打開(kāi)Fiddler，在“Request builder”欄輸入地址“http://localhost:9000/api/contacts”，然后移動(dòng)到“Request Headers”在“User-Agent” 項(xiàng)下方添加 “Accept: application/json”
按下 Exectue按鈕，雙擊左邊的Panel查看HTTP的response，切換到“Raw”Tab，你可以看到下面的json格式的數(shù)據(jù)：
8、啟用OData 查詢支持
Web API支持OData協(xié)議，接受OData的URI格式查詢，當(dāng)OData 查詢到達(dá)Web Api， 在返回客戶端之前在服務(wù)端會(huì)進(jìn)行必要的過(guò)濾和排序。查詢使用IQueryable 接口，服務(wù)端并沒(méi)有去查詢所有的數(shù)據(jù)，發(fā)送過(guò)濾和排序到服務(wù)端。
returncontacts.AsQueryable();
運(yùn)行程序，在瀏覽器里輸入 http://localhost:9000/api/contacts?$Top=4&$OrderBy=Name，看到瀏覽器之返回了按名字排序的top 4個(gè)contract
也可以通過(guò)Fidder去查詢，具體可參照第7步。
總結(jié)
通過(guò)這個(gè)Quick start，我們學(xué)習(xí)到了以下內(nèi)容
如何使用NuGet向項(xiàng)目中添加Web Api引用
如何創(chuàng)建一個(gè)通過(guò)HTTP GET訪問(wèn)的Web Api
如何通過(guò)ASP.NET routes宿主一個(gè)Web Api
如何通過(guò)瀏覽器或者Fiddler訪問(wèn)Web Api
如何在Api上啟用OData uri查詢
出處：http://shanyou.cnblogs.com/
【編輯推薦】
- 淺析.NET中的Server push技術(shù)
- .NET動(dòng)靜結(jié)合編程 接口和委托的約束強(qiáng)度
- 使用.NET Array類的Sort方法分類數(shù)值
- WCF特點(diǎn)具體優(yōu)勢(shì)總結(jié)
- WCF事件通知具體實(shí)現(xiàn)方法詳解
