且构网

分享程序员开发的那些事...
且构网 - 分享程序员编程开发的那些事

关于 webApi 返回json 和 xml 的问题

更新时间:2022-08-21 23:01:02

  每次遇到问题,解决之后,记录下来,以便以后查阅!

对于mvc webApi 默认的返回参数是json格式的,而我在和同程艺龙做接口对接的时候,因为同程艺龙 传递的参数和返回的数据都要求用xml 格式,所以只能改变默认的返回参数:

    在 Register 注册时修改: 

             var format = config.Formatters;

            format.Remove(format.JsonFormatter);   //移除默认json返回模板

       format.XmlFormatter.UseXmlSerializer = true;  // 获取或设置一个值,该值指示 XML 格式化程序是否将 System.Xml.Serialization.XmlSerializer 而非 System.Runtime.Serialization.DataContractSerializer

     这段代码基本就能实现,返回xml格式的数据


对接问题已经解决,但是在做内部对接的时候发现,内部全部使用json格式进行传递,而现在的webApi 接口都是返回的xml 数据,这就比较尴尬了,只能改了

      查了N多资料,也不知道对不对,反正我是整理了一个基本的开发思路:(webApi默认是有四种返回格式模板,常用的是json和xml,而返回的参数默认方式是排在第一位的为准,也就是json)

1.移除json模板,此时默认的格式即为xml格式

2.再加入json

理论上是可以的,但是实践的时候发现并没有成功,因为如果只是这样的话,还是只是会采用默认的返回格式,也就是xml

后来查资料发现,MediaTypeMappings(获取与媒体类型的 HTTP 请求匹配的 System.Net.Http.Formatting.MediaTypeMapping 对象的可变集合),可以实现,但是需要带入参数,实现如下:

 format.JsonFormatter.MediaTypeMappings.Add(new QueryStringMapping("t", "json", "application/json"))

返回例子: weiabi?t =json

 测试,功能实现,全部代码整体如下:

              var format = config.Formatters;
              var jsonConfig = format.JsonFormatter;
              format.Remove(format.JsonFormatter);
              format.XmlFormatter.UseXmlSerializer = true;
              format.Add(jsonConfig);
             format.JsonFormatter.MediaTypeMappings.Add(new QueryStringMapping("t", "json", "application/json"));

以上,如果哪位小伙伴有更好的实现方式,欢迎留言学习