如何强制ASP.NET Web API始终返回JSON?


103

默认情况下,ASP.NET Web API进行内容协商-将基于Accept标头返回XML或JSON或其他类型。我不需要/想要这个,是否有一种方法(例如属性或其他东西)告诉Web API始终返回JSON?


您可能能够执行此操作,从GlobalConfiguration.Configuration.Formatters
Claudio Redi 2012年

Answers:


75

在ASP.NET Web API中仅支持JSON – 正确的方法

用JsonContentNegotiator替换IContentNegotiator:

var jsonFormatter = new JsonMediaTypeFormatter();
//optional: set serializer settings here
config.Services.Replace(typeof(IContentNegotiator), new JsonContentNegotiator(jsonFormatter));

JsonContentNegotiator的实现:

public class JsonContentNegotiator : IContentNegotiator
{
    private readonly JsonMediaTypeFormatter _jsonFormatter;

    public JsonContentNegotiator(JsonMediaTypeFormatter formatter) 
    {
        _jsonFormatter = formatter;    
    }

    public ContentNegotiationResult Negotiate(
            Type type, 
            HttpRequestMessage request, 
            IEnumerable<MediaTypeFormatter> formatters)
    {
        return new ContentNegotiationResult(
            _jsonFormatter, 
            new MediaTypeHeaderValue("application/json"));
    }
}

4
代码的第一部分也在哪里剪切和粘贴?我在Global.asax中看不到“ config”对象。这个变量从哪里来?这篇文章也没有解释。
BuddyJoe

3
检查WebApiConfig.cs文件中的公共静态void Register(HttpConfiguration config){...}方法,该方法已由VS2012在项目创建时进行了整理
Dmitry Pavlov

从客户端AcceptXML将获得JSON而不会获得406的意义上来说,这会强制JSON 吗?
路加·普普利特

1
我可以回答自己的评论/问题:无论Accept标头是什么,它都会返回XML 。
路加·普普利特

2
这破坏了我的swashbuckle集成,似乎与github(github.com/domaindrivendev/Swashbuckle/issues/219)上的此问题有关。我想使用这种方法,但是下面使用的GlobalConfiguration...Clear()实际上是可行的。
seangwright 2015年

167

清除所有格式化程序,然后重新添加Json格式化程序。

GlobalConfiguration.Configuration.Formatters.Clear();
GlobalConfiguration.Configuration.Formatters.Add(new JsonMediaTypeFormatter());

编辑

我把它加Global.asax进去了Application_Start()


以及哪个文件.. ?? global.ascx .. ??
shashwat

在您的Application_Start()方法中
Jafin 2013年

6
Filip W现在有了更好的方法:),在这里看到它strathweb.com/2013/06/…–
Tien Do

7
@TienDo-链接到Filip自己的博客吗?
2013年

10

Philip W的答案是正确的,但为清晰起见和完整的工作方案,请编辑Global.asax.cs文件,使其看起来像这样:(注意,我必须将参考System.Net.Http.Formatting添加到库存生成的文件中)

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net.Http.Formatting;
using System.Web;
using System.Web.Http;
using System.Web.Mvc;
using System.Web.Optimization;
using System.Web.Routing;

namespace BoomInteractive.TrainerCentral.Server {
    // Note: For instructions on enabling IIS6 or IIS7 classic mode, 
    // visit http://go.microsoft.com/?LinkId=9394801

    public class WebApiApplication : System.Web.HttpApplication {
        protected void Application_Start() {
            AreaRegistration.RegisterAllAreas();

            WebApiConfig.Register(GlobalConfiguration.Configuration);
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);

            //Force JSON responses on all requests
            GlobalConfiguration.Configuration.Formatters.Clear();
            GlobalConfiguration.Configuration.Formatters.Add(new JsonMediaTypeFormatter());
        }
    }
}

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

这将清除XML格式化程序,因此默认为JSON格式。


完善所需的一切
tfa

4

受德米特里·帕夫洛夫(Dmitry Pavlov)出色回答的启发,我对其进行了一些改动,以便可以插入想要执行的任何格式化程序。

归功于Dmitry。

/// <summary>
/// A ContentNegotiator implementation that does not negotiate. Inspired by the film Taken.
/// </summary>
internal sealed class LiamNeesonContentNegotiator : IContentNegotiator
{
    private readonly MediaTypeFormatter _formatter;
    private readonly string _mimeTypeId;

    public LiamNeesonContentNegotiator(MediaTypeFormatter formatter, string mimeTypeId)
    {
        if (formatter == null)
            throw new ArgumentNullException("formatter");

        if (String.IsNullOrWhiteSpace(mimeTypeId))
            throw new ArgumentException("Mime type identifier string is null or whitespace.");

        _formatter = formatter;
        _mimeTypeId = mimeTypeId.Trim();
    }

    public ContentNegotiationResult Negotiate(Type type, HttpRequestMessage request, IEnumerable<MediaTypeFormatter> formatters)
    {
        return new ContentNegotiationResult(_formatter, new MediaTypeHeaderValue(_mimeTypeId));
    }
}

2

如果只想对一个方法执行此操作,则将您的方法声明为return,HttpResponseMessage而不是IEnumerable<Whatever>执行以下操作:

    public HttpResponseMessage GetAllWhatever()
    {
        return Request.CreateResponse(HttpStatusCode.OK, new List<Whatever>(), Configuration.Formatters.JsonFormatter);
    }

这段代码对单元测试很痛苦,但是这也是可能的:

    sut = new WhateverController() { Configuration = new HttpConfiguration() };
    sut.Configuration.Formatters.Add(new Mock<JsonMediaTypeFormatter>().Object);
    sut.Request = new HttpRequestMessage();

如果您只想要一种方法,请创建一个msdn.microsoft.com/zh-cn/library/…–
Elisabeth


0

可以在WebApiConfig.cs中使用:

config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));

0

对于那些使用OWIN

GlobalConfiguration.Configuration.Formatters.Clear();
GlobalConfiguration.Configuration.Formatters.Add(new JsonMediaTypeFormatter());

变为(在Startup.cs中):

   public void Configuration(IAppBuilder app)
        {
            OwinConfiguration = new HttpConfiguration();
            ConfigureOAuth(app);

            OwinConfiguration.Formatters.Clear();
            OwinConfiguration.Formatters.Add(new DynamicJsonMediaTypeFormatter());

            [...]
        }
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.