前言
这篇文章是入门级的实现,在 联系人SPA应用 系列中,准备引入WebAPI的时候,发现入门介绍占用太多篇幅,影响了文章结构,因此将此篇单独出来。
此文可以作为前端程序员了解后端开发,后端程序员很忙,或者想体验一下后端开发时候的入门级参考资料。
后端程序员可以忽略之。
开发环境
Microsoft Visual Studio 2013
Visual basic.NET 语言
创建项目
- 打开Visual Studio 2013
-
新建一个空的ASP.NET Web应用程序项目,命名为DemoSPA。
选择Empty模板,一来可以避免VS自动引用一大堆无需使用的DLL以及Javascript,二来通过从一个空的项目,逐步添加代码及配置,可以更容易了解WebAPI的基本依赖及最小运行需求。
上图是一个空的ASP.NET项目结构。 -
Nuget添加Microsoft ASP.NET Web API 2.2 (最新版本5.2.3)
安装Web API 2.2包,将自动安装相应的依赖,如下图所示。
-
添加全局应用程序类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
- 添加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,建议修改一下,否则你会失望的。
运行后,看到如下界面
由于我们没有编写默认访问页面,此处出现403错误是正常的,我们只需要在URL后面加上“/api/values”即可以访问刚刚编写的ValuesController。
这是浏览器中看到的,
使用Postman
总结
这是一个Hello World级别的WebAPI入门指南,相对于微软提供的整站WebAPI模板,优点是排除了其他无关的干扰,所有的注意力集中在WebAPI的创建和服务提供。