Jak zmusić interfejs API sieci Web ASP.NET, aby zawsze zwracał kod JSON?

ASP.NET Web API domyślnie negocjuje zawartość - zwróci XML, JSON lub inny typ na podstawie Acceptnagłówka. Nie potrzebuję / nie chcę tego, czy istnieje sposób (na przykład atrybut lub coś), aby powiedzieć interfejsowi API sieci Web, aby zawsze zwracał JSON?

Obsługa tylko formatu JSON w ASP.NET Web API - WŁAŚCIWY SPOSÓB

Zamień IContentNegotiator na JsonContentNegotiator:

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

Implementacja 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"));
    }
}

Wyczyść wszystkie elementy formatujące i dodaj ponownie program formatujący Json.

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

EDYTOWAĆ

Dodałem to do Global.asaxśrodka Application_Start().

Philip W miał właściwą odpowiedź, ale dla jasności i kompletnego działającego rozwiązania, edytuj plik Global.asax.cs tak, aby wyglądał następująco: (Zauważ, że musiałem dodać referencję System.Net.Http.Formatting do pliku wygenerowanego w magazynie)

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

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

Spowoduje to wyczyszczenie programu formatującego XML, a tym samym ustawienie domyślnego formatu JSON.

Zainspirowany doskonałą odpowiedzią Dmitrija Pawłowa, nieznacznie ją zmieniłem, aby móc podłączyć dowolny formatyzator, którego chciałem wymusić.

Kredyt dla Dmitrija.

/// <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));
    }
}

Jeśli chcesz to zrobić tylko dla jednej metody, zadeklaruj swoją metodę jako zwracającą HttpResponseMessagezamiast IEnumerable<Whatever>i wykonaj:

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

ten kod jest trudny do testowania jednostkowego, ale jest to również możliwe w następujący sposób:

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

To ma ustawione poprawne nagłówki. Wydaje się nieco bardziej elegancki.

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

Możesz użyć w WebApiConfig.cs:

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

dla osób używających OWIN

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

staje się (w Startup.cs):

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

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

            [...]
        }