C# web api返回类型设置为json的两种方法

转载 2015年07月07日 17:38:05
web api写api接口时默认返回的是把你的对象序列化后以XML形式返回,那么怎样才能让其返回为json呢,下面就介绍两种方法: 
方法一:(改配置法) 

找到Global.asax文件,在Application_Start()方法中添加一句: 
代码如下:

GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear(); 

修改后: 
代码如下:

protected void Application_Start() 

AreaRegistration.RegisterAllAreas(); 
WebApiConfig.Register(GlobalConfiguration.Configuration); 
FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters); 
RouteConfig.RegisterRoutes(RouteTable.Routes); 
// 使api返回为json 
GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear(); 


这样返回的结果就都是json类型了,但有个不好的地方,如果返回的结果是String类型,如123,返回的json就会变成"123"; 

解决的方法是自定义返回类型(返回类型为HttpResponseMessage) 
代码如下:

public HttpResponseMessage PostUserName(User user) 

String userName = user.userName; 
HttpResponseMessage result = new HttpResponseMessage { Content = new StringContent(userName,Encoding.GetEncoding("UTF-8"), "application/json") }; 
return result; 


方法二:(万金油法) 

方法一中又要改配置,又要处理返回值为String类型的json,甚是麻烦,不如就不用web api中的的自动序列化对象,自己序列化后再返回 
代码如下:

public HttpResponseMessage PostUser(User user) 

JavaScriptSerializer serializer = new JavaScriptSerializer(); 
string str = serializer.Serialize(user); 
HttpResponseMessage result = new HttpResponseMessage { Content = new StringContent(str, Encoding.GetEncoding("UTF-8"), "application/json") }; 
return result; 


方法二是我比较推荐的方法,为了不在每个接口中都反复写那几句代码,所以就封装为一个方法这样使用就方便多了。 
代码如下:

public static HttpResponseMessage toJson(Object obj) 

String str; 
if (obj is String ||obj is Char) 

str = obj.ToString(); 

else 

JavaScriptSerializer serializer = new JavaScriptSerializer(); 
str = serializer.Serialize(obj); 

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


方法三:(最麻烦的方法) 

方法一最简单,但杀伤力太大,所有的返回的xml格式都会被毙掉,那么方法三就可以只让api接口中毙掉xml,返回json 

先写一个处理返回的类: 
代码如下:

public class JsonContentNegotiator : IContentNegotiator 

private readonly JsonMediaTypeFormatter _jsonFormatter; 

public JsonContentNegotiator(JsonMediaTypeFormatter formatter) 

_jsonFormatter = formatter; 


public ContentNegotiationResult Negotiate(Type type, HttpRequestMessage request, IEnumerable<MediaTypeFormatter> formatters) 

var result = new ContentNegotiationResult(_jsonFormatter, new MediaTypeHeaderValue("application/json")); 
return result; 



找到App_Start中的WebApiConfig.cs文件,打开找到Register(HttpConfiguration config)方法 

添加以下代码: 
代码如下:

var jsonFormatter = new JsonMediaTypeFormatter(); 
config.Services.Replace(typeof(IContentNegotiator), new JsonContentNegotiator(jsonFormatter)); 

添加后代码如下: 
代码如下:

public static void Register(HttpConfiguration config) 

config.Routes.MapHttpRoute( 
name: "DefaultApi", 
routeTemplate: "api/{controller}/{action}/{id}", 
defaults: new { id = RouteParameter.Optional } 
); 
var jsonFormatter = new JsonMediaTypeFormatter(); 
config.Services.Replace(typeof(IContentNegotiator), new JsonContentNegotiator(jsonFormatter)); 


方法三如果返回的结果是String类型,如123,返回的json就会变成"123",解决方法同方法一。 

其实web api会自动把返回的对象转为xml和json两种格式并存的形式,方法一与方法三是毙掉了xml的返回,而方法二是自定义返回。

C# web api返回类型设置为json的两种方法

C# web api返回类型设置为json的两种方法
  • wyqlxy
  • wyqlxy
  • 2015年10月20日 20:00
  • 1235

C# web api返回类型设置为json的两种方法

C# web api返回类型设置为json的两种方法 web api写api接口时默认返回的是把你的对象序列化后以XML形式返回,那么怎样才能让其返回为json呢,下面就介绍两种方法:  ...
  • dzta831121
  • dzta831121
  • 2014年12月29日 17:54
  • 2275

ASP.NET Web API 配置返回的json字段的格式以及Action返回HttpResponseMessage类型

1. 对于返回的Json对象格式是以“帕斯卡”风格的(例如“FirstName”),然而我们的Api有很大的可能被带有Javascript的客户端消费,对于JS开发者来说可能更适合“驼峰”风格(例如”...
  • lglgsy456
  • lglgsy456
  • 2014年04月15日 15:34
  • 12099

C# web api返回类型设置为json的两种方法

C# web api返回类型设置为json的两种方法 web api写api接口时默认返回的是把你的对象序列化后以XML形式返回,那么怎样才能让其返回为json呢,下面就介绍两种方法:  ...
  • dzta831121
  • dzta831121
  • 2014年12月29日 17:54
  • 2275

C# web api返回类型设置为json的两种方法

C# web api返回类型设置为json
  • nic7968
  • nic7968
  • 2014年07月30日 16:10
  • 405

C# web api返回类型设置为json的两种方法

C# web api返回类型设置为json的两种方法
  • wyqlxy
  • wyqlxy
  • 2015年10月20日 20:00
  • 1235

C# web api返回类型设置为json

web api写api接口时默认返回的是把你的对象序列化后以XML形式返回,那么怎样才能让其返回为json呢,下面就介绍两种方法: 方法一:(改配置法) 找到Global.asax文件,在Applic...
  • qq183518918
  • qq183518918
  • 2013年12月28日 12:14
  • 1398

C#实现Web文件上传的两种方法

 C#实现Web文件上传的两种方法  1. C#实现Web文件的上传     在Web编程中,我们常需要把一些本地文件上传到Web服务器上,上传后,用户可以通过浏览器方便地浏览这些文件,...
  • ziyikongfu
  • ziyikongfu
  • 2014年04月09日 09:28
  • 257

C#后台返回json类型数据

  • 2013年11月29日 09:09
  • 2KB
  • 下载

c#调用百度地图web服务api-----该方法可用在js跨域请求上

百度地图Web服务API为开发者提供http接口,即开发者通过http形式发起检索请求,获取返回json或xml格式的检索数据。用户可以基于此开发JavaScript、C#、C++、Java等语言的地...
  • q383965374
  • q383965374
  • 2013年09月11日 10:25
  • 3387
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:C# web api返回类型设置为json的两种方法
举报原因:
原因补充:

(最多只允许输入30个字)