公司的許多專案前期一直是用的WebForms。但因為業務的發展,公司要在原有的專案上接入行動端,webservice有點老舊了,現在比較流行RESTFul,於是乎就想到了WebAPI。
一、如果是新建專案最簡單,檔案=>新建=>專案=>Web=> ASP.NET Web 應用程序,在下方同時勾選Web Forms 和Web API 核心引用即可,webfroms核心和WebAPI核心的應用程式就創建好了。
#二、如果是原有的項目上增加WebAPI,只要將相關的套件引用即可。
1.這裡先建立WebForms 應用程式
#2.Webfroms專案建立完成後,需要用到VS的NuGet套件管理器。右鍵引用,選擇 管理NuGet程式包。
選擇 瀏覽,搜尋WebAPI,選擇第一個Microsoft.AspNet.WebApi;點選右邊的安裝後點選確定,後選擇我接受,等到輸出顯示成功,則安裝完成。
#3.右鍵點選Web項目,新增名為App_Start的資料夾,在App_Start資料夾下建立名為WebApiConfig的cs檔案。
清理命名空間,將類別變更為static類型,新增必要程式碼,缺少引用的自行引用。
完整程式碼如下:
using System;using System.Collections.Generic;using System.Linq;using System.Web;using System.Web.Http;namespace WebFormsDemo {public static class WebApiConfig {public static void Register(HttpConfiguration config) {// Web API 配置和服务// Web API 路由 config.MapHttpAttributeRoutes(); config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optional } ); } } }
4.需要在Global.asax檔案下的Application_Start方法中註冊一下WebAPI,這裡需要引用System.Web.Http;完整程式碼如下:
protected void Application_Start(object sender, EventArgs e) {// 在应用程序启动时运行的代码 GlobalConfiguration.Configure(WebApiConfig.Register); }
#5.接下來讓我們來測試一下,新建一個Controller
6.瀏覽器訪問http://localhost:27650/api/values/get?id=1,測試通過。
三、使用OWIN來作為宿主啟動Webapi
上述是使用Global方式啟動WebAPI,如果專案中使用的SignalR ,就必須使用OWIN來作為宿主,雖然網上有教程Global也可以啟動SignalR(在中Application_Start方法加上一句 RouteTable.Routes.MapHubs();),但是微軟早在2014年6月就對其聲明了過時,建議使用Owin Startup Class的方式啟動SignalR。 ()
1.廢話不多說,新建Startup類別
#2.直接在Configuration 方法下新建一個ConfigureWebapi方法,完整程式碼如下:
/// <summary>/// 配置Webapi/// </summary>/// <param>public void ConfigureWebapi(IAppBuilder app) {//创建一个HTTP的实例配置HttpConfiguration config = new HttpConfiguration();//映射路由 config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optional } );//将配置注入OWIN管道中 app.UseWebApi(config); }
3.我們發現,有錯誤訊息IAppBuilder中未包含UseWebApi的定義,原因是缺少Self-Host寄宿支持,在程式包管理器控制台,中輸入以下指令:
Install-Package Microsoft.AspNet.WebApi.OwinSelfHost
4.安装完成后错误提示消失
5.移除Global中的启动方式,并将ConfigureWebapi方法初始化。
6.让我们来测试一下,http://localhost:27650/api/values/get?id=1,报错误404.
7.原因是还缺少一个名为 Microsoft.Owin.Host.SystemWeb 的包,这个包提供了Owin服务运行ASP.NET 网络请求管道。在程序包管理器控制台,中输入以下指令:
install-package Microsoft.Owin.Host.SystemWeb
8.让我们再来测试一下,浏览器中输入http://localhost:27650/api/values/get?id=1,测试通过。
最后,值得一提的是官方的教程大多都使用隐式类型var 关键字,有网友说使用隐式类型的好处有
1.它有利于更好地为本地变量命名。
2. 它有利于设计更好的API。
3. 它促使对变量进行初始化。
4. 它消除了代码的混乱。
5. 它不需要using指示符。
楼主还没有深刻的体会和研究,不敢在这里妄加解释。还在学习中,下面是微软官方的文档,大家感受一下。
文章到这里就结束了,其实写如何搭建WebAPI的文章也很多,这里仅仅是做一下记录,以防自己忘掉,如果此文章有幸被你看到,欢迎不吝指教。
以上是怎麼在Webforms 下搭建WebAPI?的詳細內容。更多資訊請關注PHP中文網其他相關文章!