AlenWu的程式學習筆記

前一陣子需要在VS 2010上開發Web API，記錄一下整個建立流程

前置作業

1. 先安裝Web API相關參考：開啟工具→NuGet套件管理員→套件管理器主控台。

   

2. 在套件管理器主控台中Key入以下文字。
   Install-Package Microsoft.AspNet.WebApi -Version 4.0.30506

   

3. 等待安裝完成後，專案就會加入下列幾個參考。

   

4. 於專案中加入資料夾：App_Start並新增一個WebApiConfig.cs檔，再新增Global.asax檔案。

   

5. 於WebApiConfig.cs中加入Route路徑解析，在routeTemplate中設定WebApi路徑：{ApiController所在資料夾名稱}/{ApiController名稱(排除Controller字樣)}/{Api中的Method名稱}。

   public static class WebApiConfig
   {
       public static void Register(HttpConfiguration config)
       {
           config.Routes.MapHttpRoute(
               name: "DefaultApi",
               routeTemplate: "WebApi/{controller}/{action}/{id}",
               defaults: new { action = RouteParameter.Optional, id = RouteParameter.Optional }
           );
       }
   }

6. 在Global.asax的Application_Start中註冊WebApiConfig

   public class Global : System.Web.HttpApplication
   {
       protected void Application_Start(object sender, EventArgs e)
       {
           WebApiConfig.Register(System.Web.Http.GlobalConfiguration.Configuration);
       }
   }

建立Web API

1. 建立Web API存放資料夾(WebApi)，加入TestController.cs檔案，要注意檔名一定要是Controller.cs結尾。
2. 繼承ApiController，並加入測試用Method → Get。

   public class TestController : ApiController
   {
       //GET api/<controller>
       public IEnumerable<string> Get()
       {
           return new string[] { "value1", "value2" };
       }
   }

3. 完成後建置方案，開啟Chrome鍵入網址http://localhost:xxxx/WebApi/Test/Get測試，成功取得資料如下圖。

參考資料

http://www.huanlintalk.com/2014/05/adding-web-api-to-aspnet-40-web-forms.html