it-swarm.com.de

Wie erzwingen, dass ASP.NET-Web-API immer JSON zurückgibt?

Die ASP.NET-Web-API führt standardmäßig eine Inhaltsaushandlung durch - gibt XML oder JSON oder einen anderen Typ zurück, der auf dem Header Accept basiert. Ich brauche/möchte dies nicht. Gibt es eine Möglichkeit (wie ein Attribut oder etwas), um der Web-API zu sagen, dass sie immer JSON zurückgeben soll?

98
Borek Bernard

nterstützt nur JSON in der ASP.NET-Web-API - THE RIGHT WAY

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"));
    }
}
74
Dmitry Pavlov

Löschen Sie alle Formatierer und fügen Sie das Json-Formatierungsprogramm zurück.

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

EDIT

Ich habe es zu Global.asax in Application_Start() hinzugefügt.

160
Filip W

Philip W hatte die richtige Antwort. Bearbeiten Sie Ihre Global.asax.cs -Datei jedoch aus Gründen der Klarheit und einer vollständigen Arbeitslösung so, dass sie wie folgt aussieht:

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

Dadurch wird das XML-Formatierungsprogramm gelöscht und somit das JSON-Format verwendet.

8
Bat_Programmer

Inspiriert von der hervorragenden Antwort von Dmitry Pavlov, habe ich sie ein wenig geändert, damit ich alle Formatierer, die ich durchsetzen wollte, einbinden kann.

Dank 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));
    }
}
3
Luke Puplett

Wenn Sie dies nur für eine Methode tun möchten, deklarieren Sie als Methode HttpResponseMessage anstelle von IEnumerable<Whatever> und führen Sie Folgendes aus:

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

Dies hat die richtigen Header eingestellt. Scheint etwas eleganter.

public JsonResult<string> TestMethod() 
{
return Json("your string or object");
}
1
Netferret

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

            [...]
        }
0
Carlo Saccone

Sie können in WebApiConfig.cs verwenden:

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