[C#][ASP.NET] Web API 開發心得 (1) - WebForm 搭配 Web API - iT 邦幫忙::一起幫忙解決難題，拯救 IT 人的一天

[C#][ASP.NET] Web API 開發心得 (1) - WebForm 搭配 Web API

c# asp.net web api webform

小碼農米爾 2018-03-11 22:31:39 ‧ 94678 瀏覽

分享至

目前開發還是習慣 WebForm，不過體驗過 MVC 各種強大功能後，例: Router、Action Filter、Model Binding，不想走回頭路，所以決定在專案內導入 Web API 搭配 WebForm 使用。

新增 WebForm 網站並加入 Web API

1. 新增空白網站

點選 Visual Studio 右上角，檔案 > 新增 > 網站或專案，這裡網站或專案都可以，然後選擇 ASP.NET 空白網站。

2. 儲存專案 .sln 檔

網站建立完成後，點選全部儲存，然後選擇外層資料夾儲存 .sln 專案檔。

3. 將網站架設在 IIS 上

因為新增空白網站時，選擇的是網站，網站執行必需架在 IIS 上，如果選擇專案就不用，可以直接用 Visual Studio 執行。

架設網站步驟，開啟 IIS 管理員，在 Default Web Site 上按右鍵選擇新增應用程式，接著選擇網站路徑。

4. 加入組件參考

開啟 Nuget 加入下列組件:

Microsoft.AspNet.WebApi
Microsoft.AspNet.WebApi.Owin
Microsoft.Owin.Host.SystemWeb

5. 新增 App_Code 資料夾，並加入 Startup.cs

我們所有的.cs程式檔，都會放在 App_Code 資料夾內，新增資料夾後加入 Startup.cs。

Startup.cs 程式碼:

[assembly: OwinStartup(typeof(Core.Startup))]

namespace Core
{
    public partial class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            var config = new HttpConfiguration();

            // Web API 路由
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
            
            app.UseWebApi(config);
        }
    }
}

6. 新增 Web API Controller

在 App_Code 資料夾內，新增 Api 資料夾用來放 Controller，接著加入 TestController 測試 Web API 有沒有正確運行。

TestController 程式碼:

namespace Api
{
    [RoutePrefix("api/test")]
    public class TestController : ApiController
    {
        //測試API
        [HttpGet]
        [Route("live")]
        public bool Live()
        {
            return true;
        }
    }
}

測試:

在瀏覽器輸入 api 網址後，正確顯示 api 的回傳值。