Как заставить веб-API ASP.NET всегда возвращать JSON?

103

Веб-API ASP.NET по умолчанию выполняет согласование содержимого - возвращает XML, JSON или другой тип на основе Acceptзаголовка. Мне это не нужно / не нужно, есть ли способ (например, атрибут или что-то в этом роде) указать веб-API всегда возвращать JSON?

Борек Бернар
источник
Вы можете сделать это, удалив все средства форматирования, кроме json изGlobalConfiguration.Configuration.Formatters
Клаудио Реди

Ответы:

75

Поддержка только JSON в веб-API ASP.NET - ПРАВИЛЬНЫЙ ПУТЬ

Замените IContentNegotiator на JsonContentNegotiator:

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
где первая часть кода тоже вырезается и вставляется? Я не вижу объекта "config" в моем Global.asax. Откуда эта переменная? статья тоже не объясняет.
BuddyJoe
3
Проверьте общедоступный статический регистр void (конфигурация HttpConfiguration) {...} в файле WebApiConfig.cs, который был создан VS2012 при создании проекта
Дмитрий Павлов,
Будет ли это форсировать JSON в том смысле, что клиентский AcceptXML получит JSON, а не 406 ?
Люк Пуплетт
1
Я могу ответить на свой комментарий / вопрос: он возвращает XML независимо от Acceptзаголовка.
Люк Пуплетт
2
Это нарушает мою интеграцию с функцией swashbuckle, и, похоже, это связано с этой проблемой на github ( github.com/domaindrivendev/Swashbuckle/issues/219 ). Я бы хотел использовать этот метод, но тот, который ниже, GlobalConfiguration...Clear()действительно работает.
seangwright
167

Очистите все средства форматирования и снова добавьте средство форматирования Json.

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

РЕДАКТИРОВАТЬ

Я добавил его Global.asaxвнутрь Application_Start().

Филип В
источник
а в каком файле .. ?? global.ascx .. ??
шашват
В вашем методе Application_Start ()
Джафин
6
Филип В стал лучше :), см. Его
Тьен До
7
@TienDo - ссылка на собственный блог Филипа?
Phill
10

У Филипа В. был правильный ответ, но для ясности и полного рабочего решения отредактируйте файл 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());
        }
    }
}
JJ_Coder4Hire
источник
9
GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();

Это очищает средство форматирования XML и, таким образом, по умолчанию использует формат JSON.

Bat_Programmer
источник
Совершенно все, что нужно
tfa
4

Вдохновленный отличным ответом Дмитрия Павлова, я немного изменил его, чтобы можно было подключить любой форматтер, который я хотел использовать.

Кредит Дмитрию.

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

Если вы хотите сделать это только для одного метода, 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/en-us/library/…
Элизабет,
2

У этого установлены правильные заголовки. Кажется немного более элегантным.

public JsonResult<string> TestMethod() 
{
return Json("your string or object");
}
Нетферрет
источник
1
Каковы полные имена классов JsonResult и Json?
Джош Уити
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());

            [...]
        }
Карло Сакконе
источник