十分钟快速实现WebAPI

前言

这篇文章是入门级的实现,在 联系人SPA应用 系列中,准备引入WebAPI的时候,发现入门介绍占用太多篇幅,影响了文章结构,因此将此篇单独出来。
此文可以作为前端程序员了解后端开发,后端程序员很忙,或者想体验一下后端开发时候的入门级参考资料。
后端程序员可以忽略之。

开发环境

Microsoft Visual Studio 2013
Visual basic.NET 语言

创建项目

  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



    系统自动生成代码

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

    Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
        ' 应用程序启动时激发
    End Sub
    Sub Session_Start(ByVal sender As Object, ByVal e As EventArgs)
        ' 会话启动时激发
    End Sub
    Sub Application_BeginRequest(ByVal sender As Object, ByVal e As EventArgs)
        ' 每个请求开始时激发
    End Sub
    Sub Application_AuthenticateRequest(ByVal sender As Object, ByVal e As EventArgs)
        ' 尝试验证用户身份时激发
    End Sub
    Sub Application_Error(ByVal sender As Object, ByVal e As EventArgs)
        ' 发生错误时激发
    End Sub
    Sub Session_End(ByVal sender As Object, ByVal e As EventArgs)
        ' 会话结束时激发
    End Sub
    Sub Application_End(ByVal sender As Object, ByVal e As EventArgs)
        ' 应用程序结束时激发
    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)
        ' 应用程序启动时激发
        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随机给的一个端口,可以在项目属性中修改。
由于我们没有编写默认访问页面,此处出现403错误是正常的,我们只需要在URL后面加上“/api/values”即可以访问刚刚编写的ValuesController。
这是浏览器中看到的,

使用Postman


这儿,可以注意到,使用浏览器直接访问和使用POSTMAN访问,返回的似乎不同,实际上,这是WebAPI的一个特性,同一个控制器同一个Action,根据客户端要求,可以返回XML或者JSON。

总结

这是一个Hello World级别的WebAPI入门指南,相对于微软提供的整站WebAPI模板,优点是排除了其他无关的干扰,所有的注意力集中在WebAPI的创建和服务提供。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,717评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,501评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,311评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,417评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,500评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,538评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,557评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,310评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,759评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,065评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,233评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,909评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,548评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,172评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,420评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,103评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,098评论 2 352

推荐阅读更多精彩内容