十分鐘快速實現(xiàn)WebAPI

前言

這篇文章是入門級的實現(xiàn)瓶埋,在 聯(lián)系人SPA應用 系列中篮愉,準備引入WebAPI的時候,發(fā)現(xiàn)入門介紹占用太多篇幅集侯,影響了文章結構被啼,因此將此篇單獨出來帜消。
此文可以作為前端程序員了解后端開發(fā),后端程序員很忙浓体,或者想體驗一下后端開發(fā)時候的入門級參考資料泡挺。
后端程序員可以忽略之。

開發(fā)環(huán)境

Microsoft Visual Studio 2013
Visual basic.NET 語言

創(chuàng)建項目

  1. 打開Visual Studio 2013
  2. 新建一個空的ASP.NET Web應用程序項目命浴,命名為DemoSPA娄猫。


    選擇Empty模板,一來可以避免VS自動引用一大堆無需使用的DLL以及Javascript生闲,二來通過從一個空的項目媳溺,逐步添加代碼及配置,可以更容易了解WebAPI的基本依賴及最小運行需求碍讯。



    上圖是一個空的ASP.NET項目結構悬蔽。
  3. Nuget添加Microsoft ASP.NET Web API 2.2 (最新版本5.2.3)


    安裝Web API 2.2包,將自動安裝相應的依賴捉兴,如下圖所示蝎困。


  4. 添加全局應用程序類Global.asax



    系統(tǒng)自動生成代碼

Imports System.Web.SessionState
Public Class Global_asax
    Inherits System.Web.HttpApplication

    Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
        ' 應用程序啟動時激發(fā)
    End Sub
    Sub Session_Start(ByVal sender As Object, ByVal e As EventArgs)
        ' 會話啟動時激發(fā)
    End Sub
    Sub Application_BeginRequest(ByVal sender As Object, ByVal e As EventArgs)
        ' 每個請求開始時激發(fā)
    End Sub
    Sub Application_AuthenticateRequest(ByVal sender As Object, ByVal e As EventArgs)
        ' 嘗試驗證用戶身份時激發(fā)
    End Sub
    Sub Application_Error(ByVal sender As Object, ByVal e As EventArgs)
        ' 發(fā)生錯誤時激發(fā)
    End Sub
    Sub Session_End(ByVal sender As Object, ByVal e As EventArgs)
        ' 會話結束時激發(fā)
    End Sub
    Sub Application_End(ByVal sender As Object, ByVal e As EventArgs)
        ' 應用程序結束時激發(fā)
    End Sub
End Class
  1. 添加Web API路由代碼
    5.1 新建一個Startup文件夾,用于存放啟動時各種不同啟動配置
    5.2 新建一個WebApiConfig類轴术,放在Startup文件夾下难衰,代碼如下
Imports System.Web.Http
Public NotInheritable Class WebApiConfig
     Public Shared Sub Register(config As HttpConfiguration)
        config.Routes.MapHttpRoute(name:="DefaultApi",
                                   routeTemplate:="api/{controller}/{id}",
                                   defaults:=New With {
                                       .id = RouteParameter.Optional
                                   })
    End Sub
End Class

5.3 修改Global.asax,加入上面寫的WebAPI路由注冊代碼

Imports System.Web.SessionState
Imports System.Web.Http
Public Class Global_asax
    Inherits System.Web.HttpApplication

    Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
        ' 應用程序啟動時激發(fā)
        GlobalConfiguration.Configure(AddressOf WebApiConfig.Register)
    End Sub

因為GlobalConfiguration類定義于System.Web.Http命名空間逗栽,所以在這兒盖袭,需要先Import System.Web.Http,否則就需要寫成

 System.Web.Http.GlobalConfiguration.Configure(AddressOf WebApiConfig.Register)

5.4 添加WebAPI控制器類ValuesController

Imports System.Net
Imports System.Web.Http
Public Class ValuesController
    Inherits ApiController
    ' GET api/<controller>
    Public Function GetValues() As IEnumerable(Of String)
        Return New String() {"value1", "value2"}
    End Function
    ' GET api/<controller>/5
    Public Function GetValue(ByVal id As Integer) As String
        Return "value"
    End Function
    ' POST api/<controller>
    Public Sub PostValue(<FromBody()> ByVal value As String)

    End Sub
    ' PUT api/<controller>/5
    Public Sub PutValue(ByVal id As Integer, <FromBody()> ByVal value As String)

    End Sub
    ' DELETE api/<controller>/5
    Public Sub DeleteValue(ByVal id As Integer)
    End Sub
End Class

代碼看起來好多的樣子彼宠,但是實際上鳄虱,你一個字都不需要寫,上面這些全部是VS自動生成的凭峡,暫時一個字都不需要修改拙已。
5.5 運行



點擊Google Chrome,即可運行剛剛新出爐的WebAPI服務項目摧冀,如果你看到的是Internet Explorer倍踪,建議修改一下,否則你會失望的索昂。
運行后建车,看到如下界面


Localhost表示本機,38777是新建ASP.NET項目時椒惨,VS隨機給的一個端口缤至,可以在項目屬性中修改。
由于我們沒有編寫默認訪問頁面康谆,此處出現(xiàn)403錯誤是正常的领斥,我們只需要在URL后面加上“/api/values”即可以訪問剛剛編寫的ValuesController嫉到。
這是瀏覽器中看到的,

使用Postman


這兒月洛,可以注意到何恶,使用瀏覽器直接訪問和使用POSTMAN訪問,返回的似乎不同膊存,實際上导而,這是WebAPI的一個特性,同一個控制器同一個Action隔崎,根據客戶端要求,可以返回XML或者JSON韵丑。

總結

這是一個Hello World級別的WebAPI入門指南爵卒,相對于微軟提供的整站WebAPI模板,優(yōu)點是排除了其他無關的干擾撵彻,所有的注意力集中在WebAPI的創(chuàng)建和服務提供钓株。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市陌僵,隨后出現(xiàn)的幾起案子轴合,更是在濱河造成了極大的恐慌,老刑警劉巖碗短,帶你破解...
    沈念sama閱讀 216,372評論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件受葛,死亡現(xiàn)場離奇詭異,居然都是意外死亡偎谁,警方通過查閱死者的電腦和手機总滩,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評論 3 392
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來巡雨,“玉大人闰渔,你說我怎么就攤上這事☆硗” “怎么了冈涧?”我有些...
    開封第一講書人閱讀 162,415評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長正蛙。 經常有香客問我督弓,道長,這世上最難降的妖魔是什么跟畅? 我笑而不...
    開封第一講書人閱讀 58,157評論 1 292
  • 正文 為了忘掉前任咽筋,我火速辦了婚禮,結果婚禮上徊件,老公的妹妹穿的比我還像新娘奸攻。我一直安慰自己蒜危,他們只是感情好,可當我...
    茶點故事閱讀 67,171評論 6 388
  • 文/花漫 我一把揭開白布睹耐。 她就那樣靜靜地躺著辐赞,像睡著了一般。 火紅的嫁衣襯著肌膚如雪硝训。 梳的紋絲不亂的頭發(fā)上响委,一...
    開封第一講書人閱讀 51,125評論 1 297
  • 那天,我揣著相機與錄音窖梁,去河邊找鬼赘风。 笑死,一個胖子當著我的面吹牛纵刘,可吹牛的內容都是我干的邀窃。 我是一名探鬼主播,決...
    沈念sama閱讀 40,028評論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼假哎,長吁一口氣:“原來是場噩夢啊……” “哼瞬捕!你這毒婦竟也來了?” 一聲冷哼從身側響起舵抹,我...
    開封第一講書人閱讀 38,887評論 0 274
  • 序言:老撾萬榮一對情侶失蹤肪虎,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后惧蛹,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體扇救,經...
    沈念sama閱讀 45,310評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,533評論 2 332
  • 正文 我和宋清朗相戀三年赊淑,在試婚紗的時候發(fā)現(xiàn)自己被綠了爵政。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,690評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡陶缺,死狀恐怖钾挟,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情饱岸,我是刑警寧澤掺出,帶...
    沈念sama閱讀 35,411評論 5 343
  • 正文 年R本政府宣布,位于F島的核電站苫费,受9級特大地震影響汤锨,放射性物質發(fā)生泄漏。R本人自食惡果不足惜百框,卻給世界環(huán)境...
    茶點故事閱讀 41,004評論 3 325
  • 文/蒙蒙 一闲礼、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦柬泽、人聲如沸慎菲。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽露该。三九已至,卻和暖如春第煮,著一層夾襖步出監(jiān)牢的瞬間解幼,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,812評論 1 268
  • 我被黑心中介騙來泰國打工包警, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留撵摆,地道東北人。 一個月前我還...
    沈念sama閱讀 47,693評論 2 368
  • 正文 我出身青樓揽趾,卻偏偏與公主長得像台汇,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子篱瞎,可洞房花燭夜當晚...
    茶點故事閱讀 44,577評論 2 353

推薦閱讀更多精彩內容

  • PLEASE READ THE FOLLOWING APPLE DEVELOPER PROGRAM LICENSE...
    念念不忘的閱讀 13,470評論 5 6
  • 最近在做項目的時候,突然接到產品經理給的一個需求痒芝,要求在項目中統(tǒng)計用戶每日步數(shù)俐筋,具體要求就是獲取手機健康應用中統(tǒng)計...
    Mars飄殤閱讀 5,375評論 24 31
  • “如果你愛他,請送他去紐約严衬,因為那里是天堂澄者;如果你恨他,請送他去紐約请琳,因為那里是地獄粱挡。”20多年前俄精,熱門劇集《北京...
    凌晨先生閱讀 357評論 0 4
  • 直到現(xiàn)在為止询筏,幾乎所有節(jié)日在我這一點意義都不存在。當然 我在此聲明 那些節(jié)日僅僅包括:即將到來的11.11以及各式...
    二尸閱讀 275評論 2 2
  • 這是我幻想了一年的日子竖慧,如今破碎嫌套。 成年人把它譽為:活該。
    西柚西柚那個V閱讀 128評論 0 1