本教程说明如何使用OWIN自托管Web API框架,在控制台应用程序中托管ASP.NET Web API。
.NET开放Web界面(OWIN)定义了.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软件包管理器”,然后选择“ 程序包管理器控制台”。在“程序包管理器控制台”窗口中,输入以下命令:
Install-Package Microsoft.AspNet.WebApi.OwinSelfHost
这将安装WebAPI OWIN自托管软件包和所有必需的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: Mon, 04 May 2020 07:35:10 GMT
Server: Microsoft-HTTPAPI/2.0
Content-Length: 19
Content-Type: application/json; charset=utf-8
}
["value1","value2"]
参考资料
https://docs.microsoft.com/en-us/aspnet/web-api/overview/hosting-aspnet-web-api/use-owin-to-self-host-web-api
描述
4月中旬开发一个小项目,App和客户端进行数据交互,为了脱离IIS(因为IIS安装太麻烦,有的客户电脑配置太低),因此我们定初步目标是采用Stock通信进行数据交互,进行一两天发现Stock开发太慢;最后网上找到使用OWIN自托管Web API框架,在控制台应用程序中托管ASP.NET Web API。