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

在VisualStudio中有兩種方式用于創(chuàng)建WebAPI項目：

1、創(chuàng)建帶MVC的WebAPI項目。

2、創(chuàng)建獨立的WebAPI項目。

一、創(chuàng)建帶MVC的WebAPI項目

在示例程序中使用的是VisualStudio 2013版本，創(chuàng)建一個新的WebAPI項目并且?guī)VC的模板，它包含了所有必要的引用。

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

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

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

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

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

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

ValuesController.cs是默認創(chuàng)建的WebAPI的控制器，包括WebAPI中常用的幾個方法，內容如下圖所示：

到此為止，已經成功創(chuàng)建了一個帶MVC的WebAPI項目。

二、創(chuàng)建獨立的WebAPI項目

在上面講解了如何使用VisualStudio創(chuàng)建一個帶MVC的WebAPI項目，接下來將會講解如何創(chuàng)建一個獨立的WebAPI項目。

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

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

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

4、這時將創(chuàng)建一個空的WebAPI項目。項目結構如下：

現(xiàn)在，我們需要使用NuGet包管理器添加最新的WebAPI引用。

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

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

7、出現(xiàn)如下圖所示的界面表示WebAPI安裝成功

8、在項目中創(chuàng)建配置文件夾，并添加配置類，配置類定義如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http;

namespace IndependentWebAPI.Configuration
{
    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 }
            );
        }
    }
}

9、添加Global.asax文件。

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

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

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

需要在Global.asax文件的Application_Start方法中調用WebApiConfig.Register()方法來配置WebAPI。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、在添加基架界面選擇WebAPI下面的WebAPI 2控制器 -空，點擊添加按鈕。截圖如下所示：

14、在添加控制器界面，輸入控制器的名稱（控制器以Controller結尾），并點擊添加按鈕。截圖如下所示：

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

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;

namespace IndependentWebAPI.Controller
{
    public class HomeController : ApiController
    {
        [HttpGet]
        public string Get()
        {
            return "Hello World";
        }
    }
}

16、編譯并運行項目，輸出結果如下圖所示：

這樣就創(chuàng)建了一個獨立的WebAPI項目。

到此這篇關于使用Visual Studio創(chuàng)建ASP.NET Web API項目的文章就介紹到這了。希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

最新評論