ASP.NET Web API'sini her zaman JSON döndürmeye nasıl zorlayabilirim?


103

ASP.NET Web API varsayılan olarak içerik anlaşması yapar - Acceptbaşlığa bağlı olarak XML veya JSON veya başka türler döndürür . Buna ihtiyacım yok / istemiyorum, Web API'ye her zaman JSON döndürmesini söylemenin bir yolu (bir öznitelik veya başka bir şey gibi) var mı?


Bunu json dışındaki tüm biçimlendiricileri kaldırarak yapabilirsinizGlobalConfiguration.Configuration.Formatters
Claudio Redi

Yanıtlar:


75

ASP.NET Web API'de yalnızca JSON desteği - DOĞRU YOL

IContentNegotiator'ı JsonContentNegotiator ile değiştirin:

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

JsonContentNegotiator uygulaması:

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
kodun ilk bölümü nerede kesilip yapıştırılıyor? Global.asax'ımda "config" nesnesi göremiyorum. Bu değişken nereden geliyor? makale de açıklamıyor.
BuddyJoe

3
Proje oluşturma sırasında VS2012 tarafından gererated olan WebApiConfig.cs dosyasındaki public static void Register (HttpConfiguration config) {...} yöntemini kontrol edin
Dmitry Pavlov

Bu Accept, XML alan bir istemcinin JSON alması ve bir 406 almaması anlamında JSON'u zorlayacak mı?
Luke Puplett

1
Kendi yorumuma / soruma cevap verebilirim: Acceptbaşlık ne olursa olsun XML döndürür .
Luke Puplett

2
Bu benim swashbuckle entegrasyonumu bozuyor ve github'daki bu sorunla ilgili görünüyor ( github.com/domaindrivendev/Swashbuckle/issues/219 ). Bu yöntemi kullanmak istiyorum ancak aşağıdaki yöntem GlobalConfiguration...Clear()gerçekten işe yarıyor.
seangwright

167

Tüm biçimlendiricileri temizleyin ve Json biçimlendiriciyi geri ekleyin.

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

DÜZENLE

Global.asaxİçine ekledim Application_Start().


ve hangi dosyada .. ?? global.ascx .. ??
shashwat

Application_Start () yönteminizde
Jafin

6
Filip W şimdi daha iyi bir yol oldu :), buradan bakın strathweb.com/2013/06/…
Tien Do

7
@TienDo - Filip'in kendi bloguna bağlanmak mı?
Phill

10

Philip W doğru cevaba sahipti, ancak netlik ve eksiksiz bir çalışma çözümü için Global.asax.cs dosyanızı şu şekilde görünecek şekilde düzenleyin: (Dikkat, System.Net.Http.Formatting referansını stok oluşturulan dosyaya eklemem gerekiyordu)

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();

Bu, XML biçimlendiriciyi temizler ve böylece varsayılan olarak JSON biçimine geçer.


Gereken her şeyi mükemmelleştirin
tfa

4

Dmitry Pavlov'un mükemmel cevabından esinlenerek, onu biraz değiştirdim, böylece uygulamak istediğim biçimlendiriciyi takabilirdim.

Dmitry'a kredi.

/// <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

Bunu yalnızca bir yöntem için yapmak istiyorsanız, yönteminizi HttpResponseMessageyerine dönen olarak bildirin IEnumerable<Whatever>ve yapın:

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

bu kod, birim testi için acı vericidir, ancak şu şekilde de mümkündür:

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

Bir yöntem için bir şey istiyorsanız, yalnızca bir msdn.microsoft.com/en-us/library/…
Elisabeth


0

WebApiConfig.cs içinde kullanabilirsiniz:

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

0

OWIN kullananlar için

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

(Startup.cs içinde) olur:

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

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

            [...]
        }
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.