C#使用Owin技術部署輕量級webApi服務


 

寫在前面:

除了使用IIS可以啟用WebApi之外,微軟還提供了Owin技術,免除了IIS繁瑣的部署配置,只需要運行編寫好的程序,即可啟用webApi服務,是不是很爽呢?

對於Owin技術的詳細介紹這里就不多說了,大伙自行百度。

 

正題:

一、需要大量的Nuget包

主要有:

1、owin

2、owin.hosting

3、webapi.owin

4、owin.host.httplistener

5、webapi.cors

Nuget包之后會自動生成引用

 

二、創建Startup類

該類用於實現webApi的各項配置

需要引用

using Owin;

using System.Web.Http;
using System.Web.Http.Cors;

using System.Net.Http.Headers;

    public class Startup
    {
        //需要nuget owin、cors、hosting、listener
        // This code configures Web API. The Startup class is specified as a type
        // parameter in the WebApp.Start method.
        /// <summary>
        /// 配置webApi文本格式、路由規則、跨域規則等參數
        /// </summary>
        /// <param name="appBuilder"></param>
        public void Configuration(IAppBuilder appBuilder)
        {
            // Configure Web API for self-host. 
            HttpConfiguration config = new HttpConfiguration();
            config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));
            config.EnableCors(new EnableCorsAttribute("*", "*", "*"));//解決跨域問題,需要nuget Cors
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }

            );
            appBuilder.UseWebApi(config);
        }
    }

 

三、編寫啟動WebApi服務的方法

需要引用

using Microsoft.Owin.Hosting;

using System.Net.Http;

        /// <summary>
        /// 初始化webApi
        /// </summary>
        private static void ApiInit()
        {
            try
            {
                //端口號
                string port = "9100";
                //電腦所有ip地址都啟用該端口服務
                string baseAddress = "http://+:" + port + "/";
                ////指定ip地址啟用該端口服務
                //string baseAddress = "http://192.168.0.70:" + port + "/";
                //啟動OWIN host 
                WebApp.Start<Startup>(url: baseAddress);
                //打印服務所用端口號
                Console.WriteLine("Http服務端口:" + port);
                //創建HttpCient測試webapi 
                HttpClient client = new HttpClient();
                //通過get請求數據
                var response = client.GetAsync("http://localhost:" + port + "/api/home").Result;
                //打印請求結果
                Console.WriteLine(response);
                Console.WriteLine("Http服務初始化成功!");
            }
            catch (Exception ex)
            {
                Console.WriteLine("Http服務初始化失敗!");
                Console.WriteLine(ex.ToString());
            }
        }

 

四、編寫webApi測試接口例子

需要引用

using System.Web.Http;

 

調用的時候url是 http://localhost:9100/api/home

接口的命名規則是:接口名+Controller

    public class HomeController:ApiController
    {
        public IHttpActionResult Get()
        {
            return Ok("Hello World!");
        }
        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)
        {
        }
    }

 

五、調用啟動web服務的方法

直接調用 ApiInit();

六、運行結果

1、軟件啟動后的結果

因為啟用的代碼中直接請求了home接口所以有返回數據

                //創建HttpCient測試webapi 
                HttpClient client = new HttpClient(); //通過get請求數據 var response = client.GetAsync("http://localhost:" + port + "/api/home").Result; //打印請求結果  Console.WriteLine(response);

2、使用瀏覽器測試結果

url格式是 http://{ip地址}:{端口號}/api/{接口名}/{id參數}

該格式可以通過Startup中的路由規則更改

ip地址:127.0.0.1

本機的ip地址

localhost

 

post、put等方法就自行測試吧

 

寫在結尾:

主要難點就是各種nuget包的引用,少了其中一個就有可能會報錯!

注意:如果在win7及以上的系統提示服務啟動失敗,需要以管理員身份運行軟件來解決!

(完)

原創於:博客園-寒子非

https://www.cnblogs.com/kellen451/p/10615289.html


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM