Wie kann ich die ASP.NET-Web-API zwingen, immer JSON zurückzugeben?

103

Die ASP.NET-Web-API führt standardmäßig eine Inhaltsaushandlung durch. Gibt XML oder JSON oder einen anderen Typ basierend auf dem AcceptHeader zurück. Ich brauche / will das nicht. Gibt es eine Möglichkeit (wie ein Attribut oder etwas anderes), die Web-API anzuweisen, immer JSON zurückzugeben?

Borek Bernard
quelle
Möglicherweise können Sie dies tun, indem Sie alle Formatierer außer json ausGlobalConfiguration.Configuration.Formatters
Claudio Redi

Antworten:

75

Unterstützung nur von JSON in der ASP.NET-Web-API - DER RICHTIGE WEG

Ersetzen Sie IContentNegotiator durch JsonContentNegotiator:

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

Implementierung von 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"));
    }
}
Dmitry Pavlov
quelle
4
Wo wird auch der erste Teil des Codes ausgeschnitten und eingefügt? Ich sehe kein "config" -Objekt in meiner Global.asax. Woher kommt diese Variable? Der Artikel erklärt es auch nicht.
BuddyJoe
3
Überprüfen Sie die Methode Public Static Void Register (HttpConfiguration config) {...} in der Datei WebApiConfig.cs, die von VS2012 bei der Projekterstellung erstellt wurde
Dmitry Pavlov
Erzwingt dies JSON in dem Sinne, dass ein AcceptXML- Client JSON erhält und keinen 406 ?
Luke Puplett
1
Ich kann meinen eigenen Kommentar / meine eigene Frage beantworten: Er gibt XML unabhängig vom AcceptHeader zurück.
Luke Puplett
2
Dies unterbricht meine Swashbuckle-Integration und es scheint, dass es mit diesem Problem auf Github zusammenhängt ( github.com/domaindrivendev/Swashbuckle/issues/219 ). Ich würde diese Methode gerne verwenden, aber die folgende Methode GlobalConfiguration...Clear()funktioniert tatsächlich.
Seangwright
167

Löschen Sie alle Formatierer und fügen Sie den Json-Formatierer wieder hinzu.

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

BEARBEITEN

Ich habe es Global.asaxinnen hinzugefügt Application_Start().

Filip W.
quelle
und in welcher Datei .. ?? global.ascx .. ??
Shashwat
In Ihrer Application_Start () -Methode
Jafin
6
Filip W ist jetzt besser geworden :), siehe hier strathweb.com/2013/06/…
Tien Do
7
@TienDo - Link zu Filip's eigenem Blog?
Phill
10

Philip W hatte die richtige Antwort, aber aus Gründen der Klarheit und einer vollständigen funktionierenden Lösung bearbeiten Sie Ihre Global.asax.cs-Datei folgendermaßen: (Beachten Sie, dass ich der referenzgenerierten Datei den Verweis System.Net.Http.Formatting hinzufügen musste.)

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());
        }
    }
}
JJ_Coder4Hire
quelle
9
GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();

Dadurch wird der XML-Formatierer gelöscht und standardmäßig das JSON-Format verwendet.

Bat_Programmer
quelle
Vervollkommnen Sie
4

Inspiriert von Dmitry Pavlovs hervorragender Antwort, habe ich sie leicht geändert, damit ich jeden Formatierer einstecken kann, den ich erzwingen wollte.

Gutschrift an 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));
    }
}
Luke Puplett
quelle
2

Wenn Sie dies nur für eine Methode tun möchten, deklarieren Sie Ihre Methode als zurückgegeben HttpResponseMessageanstelle von IEnumerable<Whatever>und tun Sie Folgendes:

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

Dieser Code ist schmerzhaft für Unit-Tests, aber das ist auch so möglich:

    sut = new WhateverController() { Configuration = new HttpConfiguration() };
    sut.Configuration.Formatters.Add(new Mock<JsonMediaTypeFormatter>().Object);
    sut.Request = new HttpRequestMessage();
Durilka
quelle
Wenn Sie etwas für eine Methode möchten, erstellen Sie nur eine msdn.microsoft.com/en-us/library/…
Elisabeth
2

Dies hat die richtigen Header gesetzt. Scheint etwas eleganter.

public JsonResult<string> TestMethod() 
{
return Json("your string or object");
}
Netferret
quelle
1
Wie lauten die vollständig qualifizierten Namen für die Klassen JsonResult und Json?
Josh Withee
0

Sie können in WebApiConfig.cs verwenden:

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

für diejenigen, die OWIN verwenden

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

wird (in Startup.cs):

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

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

            [...]
        }
Carlo Saccone
quelle