首頁 > 文章 > 後端開發 > 讓WebAPI 傳回JSON格式的資料實例教學

讓WebAPI 傳回JSON格式的資料實例教學

零下一度原創: 2018-05-21 11:10:0310568瀏覽

在RestFul風格盛行的年代，對接接口大多數人會選擇使用JSON,XML和JSON的對比傳送（），看看這位博主是怎麼說的，雖然最後沒有說完，我想大概也能略微解決心中的疑惑。

1.其實要想讓WebAPI 回傳JSON格式的資料很簡單，只要在ConfigureWebapi方法中設定一下即可。先前需要引用兩個命名空間。

using Newtonsoft.Json.Serialization;using System.Linq;

2.核心程式碼如下：

var json = config.Formatters.JsonFormatter;// 解决json序列化时的循环引用问题json.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;// 移除XML序列化器config.Formatters.Remove(config.Formatters.XmlFormatter);//设置序列化方式为驼峰命名法var jsonFormatter = config.Formatters.OfType<system.net.http.formatting.jsonmediatypeformatter>().First();
 jsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();//  Web API 路由config.MapHttpAttributeRoutes();</system.net.http.formatting.jsonmediatypeformatter>

#完整程式碼如下：

        /// <summary>/// 配置WebApi/// </summary>/// <param>public void ConfigureWebapi(IAppBuilder app)
        {//创建一个HTTP的实例配置var config = new HttpConfiguration();var json = config.Formatters.JsonFormatter;// 解决json序列化时的循环引用问题json.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;// 移除XML序列化器            config.Formatters.Remove(config.Formatters.XmlFormatter);//设置序列化方式为驼峰命名法var jsonFormatter = config.Formatters.OfType<system.net.http.formatting.jsonmediatypeformatter>().First();
            jsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();//  Web API 路由            config.MapHttpAttributeRoutes();//映射路由            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );//将配置注入OWIN管道中            app.UseWebApi(config);
        }</system.net.http.formatting.jsonmediatypeformatter>

##3 .接下來讓我們來測試一下，新增一個名為ProductController的Controller，刪除所有的方法，新增一個GetProductList方法，程式碼如下：

       [HttpGet]public HttpResponseMessage GetProduct()
        {var product = new { id = 1, name = "三星王炸" };

            HttpResponseMessage result = new HttpResponseMessage();
            result.Content = new StringContent(JsonConvert.SerializeObject(product), Encoding.GetEncoding("UTF-8"), "application/json");return result;
        }

4.在瀏覽器中輸入http://localhost :27650/api/product/GetProduct ，輸出結果為

讓WebAPI 傳回JSON格式的資料實例教學

5.我們發現如果在瀏覽器中輸入http://localhost:27650/api/product 同樣也可以得到回傳值，讓我們來簡單改造一下重新再寫一個新方法

        [HttpGet]public HttpResponseMessage GetProduct2(string id)
        {var product = new { id = id, name = "三星王炸" };

            HttpResponseMessage result = new HttpResponseMessage();
            result.Content = new StringContent(JsonConvert.SerializeObject(product), Encoding.GetEncoding("UTF-8"), "application/json");return result;
        }

#6.在瀏覽器中輸入http://localhost:27650/api/product?id =3 和http://localhost:27650/api/product 得到的結果分別為

讓WebAPI 傳回JSON格式的資料實例教學

為什麼會出現這種現象呢，大家看看我們開始在設定WebAPI的路由規則，規則是api/{controller}/{id} ,也就是說此規則不會去符合action的名稱，而是根據傳入的參數類型和個數來決定的。

讓WebAPI 傳回JSON格式的資料實例教學

7.那麼如何讓WebAPI 根據方法名稱來匹配呢，讓我們來修改一下路由規則，程式碼如下：

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

8.讓我們再測試一下，瀏覽器中輸入http://localhost:27650/api/product，看看效果。

讓WebAPI 傳回JSON格式的資料實例教學