让WebAPI 返回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.OfTyPESystem.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.OfTypeSystem.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格式的数据实例教程的详细内容，更多请关注其它相关文章！

声明：本文内容由网友自发贡献，本站不承担相应法律责任。对本内容有异议或投诉，请联系2913721942#qq.com核实处理，我们将尽快回复您，谢谢合作！