使用 OWIN 來Self-Host ASP.NET Web API

發行項
07/13/2023

本教學課程示範如何使用 OWIN 在主控台應用程式中裝載 ASP.NET Web API，以自我裝載 Web API 架構。

開啟 .NET (OWIN 的 Web 介面) 定義 .NET Web 服務器與 Web 應用程式之間的抽象概念。 OWIN 會將 Web 應用程式與伺服器分離，這讓 OWIN 非常適合在 IIS 外部的您自己的進程中自我裝載 Web 應用程式。

教學課程中使用的軟體版本

Visual Studio 2017

Web API 5.2.7

注意

您可以在 github.com/aspnet/samples找到本教學課程的完整原始程式碼。

建立主控台應用程式

在 [ 檔案] 功能表上，選取 [ 新增]，然後選取 [專案]。從 [已安裝] 的 [Visual C#] 底下，選取 [Windows 桌面 ]，然後選取 [ 主控台應用程式] (.Net Framework) 。將專案命名為「OwinSelfhostSample」，然後選取 [ 確定]。

新增 Web API 和 OWIN 套件

從 [ 工具] 功能表中，選取 [NuGet 套件管理員]，然後選取 [ 套件管理員主控台]。在 [Package Manager Console] 視窗中，輸入下列命令：

Install-Package Microsoft.AspNet.WebApi.OwinSelfHost

這會安裝 WebAPI OWIN selfhost 套件和所有必要的 OWIN 套件。

設定自我主機的 Web API

在方案總管中，以滑鼠右鍵按一下專案，然後選取 [新增 / 類別] 以新增類別。將類別命名為 Startup。

方案總管對話方塊功能表的螢幕擷取畫面，其中顯示將類別新增至專案時所要遵循的步驟。

將此檔案中的所有重複使用程式碼取代為下列專案：

using Owin; 
using System.Web.Http; 

namespace OwinSelfhostSample 
{ 
    public class Startup 
    { 
        // This code configures Web API. The Startup class is specified as a type
        // parameter in the WebApp.Start method.
        public void Configuration(IAppBuilder appBuilder) 
        { 
            // Configure Web API for self-host. 
            HttpConfiguration config = new HttpConfiguration(); 
            config.Routes.MapHttpRoute( 
                name: "DefaultApi", 
                routeTemplate: "api/{controller}/{id}", 
                defaults: new { id = RouteParameter.Optional } 
            ); 

            appBuilder.UseWebApi(config); 
        } 
    } 
}

新增 Web API 控制器

接下來，新增 Web API 控制器類別。在方案總管中，以滑鼠右鍵按一下專案，然後選取 [新增 / 類別] 以新增類別。將類別命名為 ValuesController。

將此檔案中的所有重複使用程式碼取代為下列專案：

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

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

        // GET api/values/5 
        public string Get(int id) 
        { 
            return "value"; 
        } 

        // POST api/values 
        public void Post([FromBody]string value) 
        { 
        } 

        // PUT api/values/5 
        public void Put(int id, [FromBody]string value) 
        { 
        } 

        // DELETE api/values/5 
        public void Delete(int id) 
        { 
        } 
    } 
}

啟動 OWIN 主機，並使用 HttpClient 提出要求

以下列專案取代 Program.cs 檔案中的所有重複使用程式碼：

using Microsoft.Owin.Hosting;
using System;
using System.Net.Http;

namespace OwinSelfhostSample 
{ 
    public class Program 
    { 
        static void Main() 
        { 
            string baseAddress = "http://localhost:9000/"; 

            // Start OWIN host 
            using (WebApp.Start<Startup>(url: baseAddress)) 
            { 
                // Create HttpClient and make a request to api/values 
                HttpClient client = new HttpClient(); 

                var response = client.GetAsync(baseAddress + "api/values").Result; 

                Console.WriteLine(response); 
                Console.WriteLine(response.Content.ReadAsStringAsync().Result); 
                Console.ReadLine(); 
            } 
        } 
    } 
 }

執行應用程式

若要執行應用程式，請在 Visual Studio 中按 F5。輸出應該看起來如下所示：

StatusCode: 200, ReasonPhrase: 'OK', Version: 1.1, Content: System.Net.Http.StreamContent, Headers: 
{ 
  Date: Tue, 09 Jul 2013 18:10:15 GMT 
  Server: Microsoft-HTTPAPI/2.0 
  Content-Length: 19 
  Content-Type: application/json; charset=utf-8 
} 
["value1","value2"]

主控台的螢幕擷取畫面，其中顯示應用程式執行時的狀態碼和資訊。