美化WebApi,使其统一返回Json格式

博客部分代码来自其他博主，暂时找不到你的博文连接，如果您觉得我的代码中引入了您的代码或者文章，可在下方把您的博客文章写在下面，谢谢！！！

WebApi有两种返回数据格式，一种是XML，一种是Json，在WebAPI中，你可以选择你自己喜欢的返回数据格式，在这里，我基本都是返回的是Json，基本上，使用WebApi 的时候，我都设置的是返回Json，我们美化接口，乃知全局，都将以Json格式显示出来！

这是 API 默认返回的XML格式，我们接下来美化一下！

一：新建一个空的WebApi项目

创建一个文件夹 ，我这里  我这里取名字为：InteFilter

创建一个类  JsonContentNegotiator  ，继承  IContentNegotiator

需要引入这三个命名空间

 using System.Net.Http;
 using System.Net.Http.Formatting;
 using System.Net.Http.Headers;

 namespace DemoApi.InteFilter
 {
     public class JsonContentNegotiator: IContentNegotiator
     {
         private readonly JsonMediaTypeFormatter _jsonFormatter;
         public JsonContentNegotiator(JsonMediaTypeFormatter formatter)
         {
             _jsonFormatter = formatter;
         }
         public ContentNegotiationResult Negotiate(Type type, HttpRequestMessage request, IEnumerable<MediaTypeFormatter> formatters)
         {
             // 对 JSON 数据使用混合大小写。驼峰式,但是是javascript 首字母小写形式.小驼峰命名法。
             //config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new  CamelCasePropertyNamesContractResolver();
             // 对 JSON 数据使用混合大小写。跟属性名同样的大小.输出
             _jsonFormatter.SerializerSettings.ContractResolver = new UnderlineSplitContractResolver(); //小写命名法。
             _jsonFormatter.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss";//解决json时间带T的问题
             _jsonFormatter.SerializerSettings.Formatting = Newtonsoft.Json.Formatting.Indented;//解决json格式化缩进问题
             _jsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;//解决json序列化时的循环引用问题
             var result = new ContentNegotiationResult(_jsonFormatter, new MediaTypeHeaderValue("application/json"));
             return result;
         }
     }

 }

二  创建 UnderlineSplitContractResolver 类  继承 DefaultContractResolver  （需要引入 using Newtonsoft.Json.Serialization;）

 namespace DemoApi.InteFilter
 {
     public class UnderlineSplitContractResolver : DefaultContractResolver
     {
         protected override string ResolvePropertyName(string propertyName)
         {
             return CamelCaseToUnderlineSplit(propertyName);//下划线分割命名法
             //return propertyName.ToLower();//小写命名法
         }

         private string CamelCaseToUnderlineSplit(string name)
         {
             StringBuilder builder = new StringBuilder();
             for (int i = ; i < name.Length; i++)
             {
                 var ch = name[i];
                 if (char.IsUpper(ch) && i > )
                 {
                     var prev = name[i - ];
                     if (prev != '_')
                     {
                         if (char.IsUpper(prev))
                         {
                             if (i < name.Length - )
                             {
                                 var next = name[i + ];
                                 if (char.IsLower(next))
                                 {
                                     builder.Append('_');
                                 }
                             }
                         }
                         else
                         {
                             builder.Append('_');
                         }
                     }
                 }

                 builder.Append(char.ToLower(ch));
             }

             return builder.ToString();
         }

     }
 }

三  打开WebApiConfig

引入

using System.Net.Http.Formatting;

   /// <summary>
    /// WebApi 网关配置 需要下载 cors 包  ，使可以跨域网站资源请求
    /// </summary>
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            #region [=>2、WebApi 返回JSON，推荐做法性能最高]
            config.Services.Replace(typeof(IContentNegotiator), new InteFilter.JsonContentNegotiator(new JsonMediaTypeFormatter()));
            #endregion
            // Web API 配置和服务

            config.MapHttpAttributeRoutes();
            // string url= "";
            var cors = new EnableCorsAttribute("*", "*", "*");
            config.EnableCors(cors);
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{action}/{id}",
                   defaults: new { controller = "Home", action = "Index", id = RouteParameter.Optional }
            );
        }
    }

结果：

致敬开源者