Web API(三):創建Web API項目


在本篇文章中將講解如何使用Visual Studio創建一個新的ASP.NET Web API項目。

在Visual Studio中有兩種方式用於創建Web API項目:

1、創建帶MVC的Web API項目。

2、創建獨立的Web API項目。

一、創建帶MVC的Web API項目

在示例程序中使用的是Visual Studio 2013版本,創建一個新的Web API項目並且帶MVC的模板,它包含了所有必要的引用。

1、選擇“文件”->“新建”->“項目”,截圖如下所示:

2、在彈出的新建項目窗口中,左側模板選擇Visual C#->Web,中間面板選擇ASP.NET Web 應用程序,輸入項目名稱,點擊確定,界面如下:

3、在彈出的新建ASP.NET項目的窗口中,模板類型選擇Web API,會看到下面默認勾選了MVC和Web API的復選框,這意味着它將添加MVC和Web API必要的文件夾和相關引用。點擊確定按鈕,界面截圖如下:

4、新建的Web API項目結構如下圖所示

這個項目就是一個默認的MVC項目加兩個為Web API准備的特定文件:即App_Start文件夾中的WebApiConfig.cs和Controllers文件夾中的ValuesController.cs文件。

WebApiConfig.cs是Web API的配置文件,可以配置Web API路由和其他信息,跟MVC的RouteConfig.cs文件的作用相同。內容如下圖所示:

ValuesController.cs是默認創建的Web API的控制器,包括Web API中常用的幾個方法,內容如下圖所示:

到此為止,已經成功創建了一個帶MVC的Web API項目。

二、創建獨立的Web API項目

在上面講解了如何使用Visual Studio創建一個帶MVC的Web API項目,接下來將會講解如何創建一個獨立的Web API項目。

1、選擇“文件”->“新建”->“項目”,截圖如下所示:

2、在彈出的新建項目窗口中,左側模板選擇Visual C#->Web,中間面板選擇ASP.NET Web 應用程序,輸入項目名稱,點擊確定,界面如下:

3、在彈出的新建ASP.NET項目的窗口中,模板類型選擇Empty,點擊確定按鈕,界面截圖如下:

4、這時將創建一個空的Web API項目。項目結構如下:

現在,我們需要使用NuGet包管理器添加最新的Web API引用。

5、右鍵單擊項目,然后單擊“管理NuGet程序包”,界面截圖如下:

6、打開管理NuGet程序包界面,在搜索框里輸入“WebAPI”,選擇Microsoft ASP.NET Web API2.2包並點擊安裝,界面如下所示:

7、出現如下圖所示的界面表示Web API安裝成功

8、在項目中創建配置文件夾,並添加配置類,配置類定義如下:

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Linq;
 4 using System.Web;
 5 using System.Web.Http;
 6 
 7 namespace IndependentWebAPI.Configuration
 8 {
 9     public static class WebApiConfig
10     {
11         public static void Register(HttpConfiguration config)
12         {
13             // Web API 配置和服務
14 
15             // Web API 路由
16             config.MapHttpAttributeRoutes();
17 
18             config.Routes.MapHttpRoute(
19                 name: "DefaultApi",
20                 routeTemplate: "api/{controller}/{id}",
21                 defaults: new { id = RouteParameter.Optional }
22             );
23         }
24     }
25 }

 9、添加Global.asax文件。

右鍵點擊項目,選擇“添加”->“新建項”,界面截圖如下:

10、在添加新項界面,選擇web下面的“全局應用程序類”,並命名為“Global.asax”,點擊添加按鈕,這樣就將Global.asax文件添加到了項目中。界面截圖如下所示:

11、配置應用程序啟動時的Web API的路由。

需要在Global.asax文件的Application_Start方法中調用WebApiConfig.Register()方法來配置Web API。Application_Start()方法定義如下:

protected void Application_Start(object sender, EventArgs e)
{
       GlobalConfiguration.Configure(WebApiConfig.Register);
}

 

配置Web API只需要使用基於代碼的配置GlobalConfiguration 類。因此,當應用程序啟動,它將調用Application_Start事件,進而調用HelloWebAPIConfig.Register()方法來配置您的Web API。

 12、添加控制器 

在項目上右鍵添加Controller文件夾,然后在新添加的Controller文件夾上右鍵選擇“添加”->“控制器”,界面截圖如下:

13、在添加基架界面選擇Web API下面的 Web API 2 控制器 -空,點擊添加按鈕。截圖如下所示:

14、在添加控制器界面,輸入控制器的名稱(控制器以Controller結尾),並點擊添加按鈕。截圖如下所示:

15、為控制器類添加簡單的GET方法,GET()方法定義如下:

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Linq;
 4 using System.Net;
 5 using System.Net.Http;
 6 using System.Web.Http;
 7 
 8 namespace IndependentWebAPI.Controller
 9 {
10     public class HomeController : ApiController
11     {
12         [HttpGet]
13         public string Get()
14         {
15             return "Hello World";
16         }
17     }
18 }

 

16、編譯並運行項目,輸出結果如下圖所示:

這樣就創建了一個獨立的Web API項目。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM