让WebAPI 返回JSON格式的数据实例教程

概述让WebAPI 返回JSON格式的数据实例教程 在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();

完整代码如下：

        /// <summary>/// 配置WebAPI/// </summary>/// <param name="app"></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);        }

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 ，输出结果为

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的路由规则，规则是API/{controller}/{ID} ,也就是说此规则不会去匹配action的名称，而是根据传入的参数类型和个数来决定的。

7.那么如何让WebAPI 根据方法名称来匹配呢，让我们来修改一下路由规则，代码如下：

config.Routes.MaphttpRoute(                name: "DefaultAPI",                routeTemplate: "API/{controller}/{action}/{ID}",                defaults: new { ID = RouteParameter.Optional }            );

8.让我们再测试一下，浏览器中输入http://localhost:27650/API/product，看一下效果。

再输入http://localhost:27650/API/product/GetProduct 和 http://localhost:27650/API/product/GetProduct?ID=5，发现两个返回的结果一样，说明访问的是同一个方法。

再输入http://localhost:27650/API/product/GetProduct2 和 http://localhost:27650/API/product/GetProduct2?ID=6

结果：

测试通过。

这里仅作整理，加深印象，以防自己忘记。如有不正确的地方，欢迎不吝指教。 总结

以上是内存溢出为你收集整理的让WebAPI 返回JSON格式的数据实例教程全部内容，希望文章能够帮你解决让WebAPI 返回JSON格式的数据实例教程所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。