Как заставить веб-API ASP.NET возвращать JSON вместо XML с помощью Chrome?

Используя ответ Фелипе Леусина в течение многих лет, после недавнего обновления основных библиотек и Json.Net я столкнулся с System.MissingMethodException: SupportedMediaTypes. В моем случае решение, которое, надеюсь, будет полезным для других, столкнувшихся с таким же непредвиденным исключением, - это установить System.Net.Http. NuGet, по-видимому, удаляет его при некоторых обстоятельствах. После ручной установки проблема была решена.

Вы можете использовать как показано ниже:

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

Я удивлен, увидев так много ответов, требующих кодирования для изменения одного варианта использования (GET) в одного API вместо использования подходящего инструмента, который нужно установить один раз и который можно использовать для любой API (собственный или сторонний) и все варианты использования.

Итак, хороший ответ:

1. Если вы хотите запросить только json или другой тип контента, установите Requestly или аналогичный инструмент и измените заголовок Accept.
2. Если вы хотите также использовать POST и иметь хорошо отформатированный json, xml и т. Д., Используйте подходящее расширение для тестирования API, например Postman или ARC.
.

        config.Formatters.Remove(config.Formatters.XmlFormatter);

Большинство приведенных выше ответов имеют смысл. Поскольку вы видите, что данные форматируются в формате XML, это означает, что применяется средство форматирования XML, поэтому вы можете увидеть формат JSON, просто удалив XMLFormatter из параметра HttpConfiguration, например

public static void Register(HttpConfiguration config)
        {
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );                
            config.Formatters.Remove(config.Formatters.XmlFormatter);                
            config.EnableSystemDiagnosticsTracing();
        }

, поскольку JSON является форматом по умолчанию

Возвращение правильного формата выполняется средством форматирования медиа-типа. Как уже упоминалось, вы можете сделать это в классе WebApiConfig:

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        ...

        // Configure Web API to return JSON
        config.Formatters.JsonFormatter
        .SupportedMediaTypes.Add(new System.Net.Http.Headers.MediaTypeHeaderValue("text/html"));

        ...
    }
}

Для получения дополнительной информации проверьте:

• Средства форматирования мультимедиа в веб-API ASP.NET 2.
• Согласование содержимого в веб-API ASP.NET.

Если ваши действия возвращают XML (что является случаем по умолчанию) и вам нужен только определенный метод для возврата JSON, вы можете затем использовать ActionFilterAttribute и применить его к этому конкретному действию.

Атрибут фильтра:

public class JsonOutputAttribute : ActionFilterAttribute
{
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        ObjectContent content = actionExecutedContext.Response.Content as ObjectContent;
        var value = content.Value;
        Type targetType = actionExecutedContext.Response.Content.GetType().GetGenericArguments()[0];

        var httpResponseMsg = new HttpResponseMessage
        {
            StatusCode = HttpStatusCode.OK,
            RequestMessage = actionExecutedContext.Request,
            Content = new ObjectContent(targetType, value, new JsonMediaTypeFormatter(), (string)null)
        };

        actionExecutedContext.Response = httpResponseMsg;
        base.OnActionExecuted(actionExecutedContext);
    }
}

Применение к действию:

[JsonOutput]
public IEnumerable<Person> GetPersons()
{
    return _repository.AllPersons(); // the returned output will be in JSON
}

Обратите внимание, что вы можете опустить слово Attribute на оформлении действия и использовать только [JsonOutput] вместо [JsonOutputAttribute].

Просто добавьте эти две строки кода в свой WebApiConfig класс

public static class WebApiConfig
{
     public static void Register(HttpConfiguration config)
     {
          //add this two line 
          config.Formatters.Clear();
          config.Formatters.Add(new JsonMediaTypeFormatter());


          ............................
      }
}

согласно последней версии ASP.net WebApi 2,

под WebApiConfig.cs, это будет работать

config.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);
config.Formatters.Add(GlobalConfiguration.Configuration.Formatters.JsonFormatter);

WebApiConfig - это место, где вы можете настроить, хотите ли вы выводить в json или xml. По умолчанию это xml. В функции регистрации мы можем использовать HttpConfiguration Formatters для форматирования вывода.

System.Net.Http.Headers => MediaTypeHeaderValue("text/html") необходим для получения вывода в формате json.

Вот самый простой способ, который я использовал в своих приложениях. Добавьте указанные ниже 3 строки кода в App_Start\\WebApiConfig.cs в Register функцию

    var formatters = GlobalConfiguration.Configuration.Formatters;

    formatters.Remove(formatters.XmlFormatter);

    config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("application/json"));

Веб-API Asp.net автоматически сериализует ваш возвращаемый объект в JSON, и поскольку application/json добавляется в заголовок, браузер или получатель поймут, что вы возвращаете результат JSON.

Просто измените App_Start/WebApiConfig.cs следующим образом:

public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services

        // Web API routes
        config.MapHttpAttributeRoutes();
        //Below formatter is used for returning the Json result.
        var appXmlType = config.Formatters.XmlFormatter.SupportedMediaTypes.FirstOrDefault(t => t.MediaType == "application/xml");
        config.Formatters.XmlFormatter.SupportedMediaTypes.Remove(appXmlType);
        //Default route
        config.Routes.MapHttpRoute(
           name: "ApiControllerOnly",
           routeTemplate: "api/{controller}"
       );
    }

Вот решение, аналогичное jayson.centeno и другим ответам, но с использованием встроенного расширения из System.Net.Http.Formatting.

public static void Register(HttpConfiguration config)
{
    // add support for the 'format' query param
    // cref: http://blogs.msdn.com/b/hongyes/archive/2012/09/02/support-format-in-asp-net-web-api.aspx
    config.Formatters.JsonFormatter.AddQueryStringMapping("$format", "json", "application/json");
    config.Formatters.XmlFormatter.AddQueryStringMapping("$format", "xml", "application/xml");

    // ... additional configuration
 }

Решение было в первую очередь ориентировано на поддержку формата $ для OData в ранних версиях WebApi, но оно также применимо к реализации без OData и возвращает Content-Type: application/json; charset=utf-8 заголовок в ответе.

Он позволяет вам добавить &$format=json или &$format=xml в конец вашего uri при тестировании в браузере. Это не влияет на другое ожидаемое поведение при использовании клиента, отличного от браузера, где вы можете установить свои собственные заголовки.

Прошло некоторое время с тех пор, как этот вопрос был задан (и дан ответ), но другой вариант - переопределить заголовок Accept на сервере во время обработки запроса с помощью MessageHandler, как показано ниже:

public class ForceableContentTypeDelegationHandler : DelegatingHandler
{
    protected async override Task<HttpResponseMessage> SendAsync(
                HttpRequestMessage request,
                CancellationToken cancellationToken)
    {
        var someOtherCondition = false;
        var accHeader = request.Headers.GetValues("Accept").FirstOrDefault();
        if (someOtherCondition && accHeader.Contains("application/xml"))
        {
            request.Headers.Remove("Accept");
            request.Headers.Add("Accept", "application/json");
        }
        return await base.SendAsync(request, cancellationToken);
    }
}

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

Вам, конечно же, нужно будет его зарегистрировать. Вы можете сделать это глобально:

  public static void Register(HttpConfiguration config) {
      config.MessageHandlers.Add(new ForceableContentTypeDelegationHandler());
  }

или по маршруту за маршрутом:

config.Routes.MapHttpRoute(
   name: "SpecialContentRoute",
   routeTemplate: "api/someUrlThatNeedsSpecialTreatment/{id}",
   defaults: new { controller = "SpecialTreatment" id = RouteParameter.Optional },
   constraints: null,
   handler: new ForceableContentTypeDelegationHandler()
);

И поскольку это обработчик сообщений, он будет работать как на стороне запроса, так и на стороне ответа конвейера, как и HttpModule. Таким образом, вы можете легко подтвердить переопределение с помощью настраиваемого заголовка:

public class ForceableContentTypeDelegationHandler : DelegatingHandler
{
    protected async override Task<HttpResponseMessage> SendAsync(
                HttpRequestMessage request,
                CancellationToken cancellationToken)
    {
        var wasForced = false;
        var someOtherCondition = false;
        var accHeader = request.Headers.GetValues("Accept").FirstOrDefault();
        if (someOtherCondition && accHeader.Contains("application/xml"))
        {
            request.Headers.Remove("Accept");
            request.Headers.Add("Accept", "application/json");
            wasForced = true;
        }

        var response =  await base.SendAsync(request, cancellationToken);
        if (wasForced){
          response.Headers.Add("X-ForcedContent", "We overrode your content prefs, sorry");
        }
        return response;
    }
}

Мне непонятно, почему в ответе столько сложности. Конечно, есть много способов сделать это с помощью QueryStrings, заголовков и параметров ... но то, что я считаю лучшей практикой, просто. Вы запрашиваете простой URL-адрес (например, http://yourstartup.com/api/cars), а взамен получаете JSON. Вы получаете JSON с правильным заголовком ответа:

Content-Type: application/json

В поисках ответа на этот же вопрос я нашел эту ветку, и мне пришлось продолжить, потому что принятый ответ не работает точно. Я нашел ответ, который, как мне кажется, слишком прост, чтобы быть лучшим:

Установить форматировщик WebAPI по умолчанию

Я тоже добавлю сюда свой совет.

WebApiConfig.cs

namespace com.yourstartup
{
  using ...;
  using System.Net.Http.Formatting;
  ...
  config.Formatters.Clear(); //because there are defaults of XML..
  config.Formatters.Add(new JsonMediaTypeFormatter());
}

У меня действительно есть вопрос, откуда берутся значения по умолчанию (по крайней мере, те, которые я вижу). Являются ли они значениями .NET по умолчанию или, возможно, созданы где-то еще (кем-то другим в моем проекте). Всегда, надеюсь, это поможет.

Из MSDN Создание одностраничного приложения с ASP.NET и AngularJS (примерно 41 минута).

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // ... possible routing etc.

        // Setup to return json and camelcase it!
        var formatter = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
        formatter.SerializerSettings.ContractResolver =
            new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver();
    }

Он должен быть актуальным, я попробовал, и он сработал.

Использование RequestHeaderMapping работает еще лучше, потому что оно также устанавливает Content-Type = application/json в заголовке ответа, что позволяет Firefox (с надстройкой JSONView) форматировать ответ как JSON.

GlobalConfiguration.Configuration.Formatters.JsonFormatter.MediaTypeMappings
.Add(new System.Net.Http.Formatting.RequestHeaderMapping("Accept", 
                              "text/html",
                              StringComparison.InvariantCultureIgnoreCase,
                              true, 
                              "application/json"));

Мне больше всего нравится подход Фелипе Леусина - убедитесь, что браузеры получают JSON без ущерба для согласования содержимого со стороны клиентов, которым действительно нужен XML. Единственное, чего мне не хватало, это то, что заголовки ответов все еще содержали content-type: text / html. Почему это было проблемой? Потому что я использую расширение JSON Formatter Chrome, которое проверяет тип содержимого, и я не получаю того красивого форматирования, к которому я привык. Я исправил это с помощью простого настраиваемого средства форматирования, которое принимает запросы text / html и возвращает ответы application / json:

public class BrowserJsonFormatter : JsonMediaTypeFormatter
{
    public BrowserJsonFormatter() {
        this.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));
        this.SerializerSettings.Formatting = Formatting.Indented;
    }

    public override void SetDefaultContentHeaders(Type type, HttpContentHeaders headers, MediaTypeHeaderValue mediaType) {
        base.SetDefaultContentHeaders(type, headers, mediaType);
        headers.ContentType = new MediaTypeHeaderValue("application/json");
    }
}

Зарегистрируйтесь так:

config.Formatters.Add(new BrowserJsonFormatter());

Поскольку вопрос относится к Chrome, вы можете получить расширение Postman, которое позволяет вам установить тип содержимого запроса.

Этот код делает json моим значением по умолчанию и позволяет мне также использовать формат XML. Я просто добавлю xml=true.

GlobalConfiguration.Configuration.Formatters.XmlFormatter.MediaTypeMappings.Add(new QueryStringMapping("xml", "true", "application/xml"));
GlobalConfiguration.Configuration.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));

Спасибо всем!

Я использовал глобальный фильтр действий, чтобы удалить Accept: application/xml, когда заголовок User-Agent содержит "Chrome":

internal class RemoveXmlForGoogleChromeFilter : IActionFilter
{
    public bool AllowMultiple
    {
        get { return false; }
    }

    public async Task<HttpResponseMessage> ExecuteActionFilterAsync(
        HttpActionContext actionContext,
        CancellationToken cancellationToken,
        Func<Task<HttpResponseMessage>> continuation)
    {
        var userAgent = actionContext.Request.Headers.UserAgent.ToString();
        if (userAgent.Contains("Chrome"))
        {
            var acceptHeaders = actionContext.Request.Headers.Accept;
            var header =
                acceptHeaders.SingleOrDefault(
                    x => x.MediaType.Contains("application/xml"));
            acceptHeaders.Remove(header);
        }

        return await continuation();
    }
}

Кажется, работает.

В WebApiConfig.cs добавьте в конец функции Register :

// Remove the XML formatter
config.Formatters.Remove(config.Formatters.XmlFormatter);

Источник.

Если вы сделаете это в WebApiConfig, вы получите JSON по умолчанию, но он все равно позволит вам возвращать XML, если вы передадите text/xml в качестве заголовка запроса Accept.

Примечание: это удаляет поддержку для application/xml

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

        var appXmlType = config.Formatters.XmlFormatter.SupportedMediaTypes.FirstOrDefault(t => t.MediaType == "application/xml");
        config.Formatters.XmlFormatter.SupportedMediaTypes.Remove(appXmlType);
    }
}

Если вы не используете тип проекта MVC и, следовательно, у вас не было этого класса для начала, см. Этот ответ, чтобы узнать, как его включить.

Не используйте браузер для тестирования API.

Вместо этого попробуйте использовать HTTP-клиент, который позволяет указать ваш запрос, например CURL или даже Fiddler.

Проблема с этой проблемой в клиенте, а не в API. Веб-API работает правильно в соответствии с запросом браузера.

В Global.asax я использую приведенный ниже код. Мой URI для получения JSON: http://www.digantakumar.com/api/values?json=true

protected void Application_Start()
{
    AreaRegistration.RegisterAllAreas();

    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);

    GlobalConfiguration.Configuration.Formatters.JsonFormatter.MediaTypeMappings.Add(new  QueryStringMapping("json", "true", "application/json"));
}

Быстрый совет №3 по MVC4 - удаление средства форматирования XML из веб-API ASP.Net

В Global.asax добавьте строку:

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

вот так:

protected void Application_Start()
{
    AreaRegistration.RegisterAllAreas();

    RegisterGlobalFilters(GlobalFilters.Filters);
    RegisterRoutes(RouteTable.Routes);

    BundleTable.Bundles.RegisterTemplateBundles();
    GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();
}

Мне показалось, что приложение Chrome «Advanced REST Client» отлично подходит для работы со службами REST. Среди прочего вы можете установить Content-Type на application/json: Расширенный клиент REST

Один из быстрых вариантов - использовать специализацию MediaTypeMapping. Вот пример использования QueryStringMapping в событии Application_Start:

GlobalConfiguration.Configuration.Formatters.JsonFormatter.MediaTypeMappings.Add(new QueryStringMapping("a", "b", "application/json"));

Теперь всякий раз, когда URL-адрес содержит строку запроса? A = b, в этом случае в браузере будет отображаться ответ Json.

Посмотрите на согласование содержимого в WebAPI. Эти (Часть 1 & Часть 2) чудесно подробные и подробные сообщения в блоге объясняют, как это работает.

Короче говоря, вы правы, вам просто нужно установить заголовки запроса Accept или Content-Type. Если ваше действие не закодировано для возврата определенного формата, вы можете установить Accept: application/json.