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

Question

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

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

562 9

asp.net-mvc asp.net-web-api

9 ответов:

Comments

Ничего не найдено.

Dmitry Pavlov · Accepted Answer · 2013-08-09 14:23:47

поддержка только JSON in ASP.NET Web API -ПРАВИЛЬНО

заменить 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"));
    }
}

Filip W · Accepted Answer · 2016-03-16 00:19:45

очистить все форматеры и добавить форматер Json обратно.
GlobalConfiguration.Configuration.Formatters.Clear();
GlobalConfiguration.Configuration.Formatters.Add(new JsonMediaTypeFormatter());
EDIT

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

JJ_Coder4Hire · Accepted Answer · 2014-05-01 21:45:07

У Филиппа W был правильный ответ, но для ясности и полного рабочего решения отредактируйте свой глобальный.асакс.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());
        }
    }
}

Bat_Programmer · Accepted Answer · 2016-01-17 02:00:51

GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();
это очищает XML-форматер и, таким образом, по умолчанию в формате JSON.

durilka · Accepted Answer · 2013-10-30 16:11:24

если вы хотите сделать это только для одного метода, то объявите свой метод как возвращающий 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();

Luke Puplett · Accepted Answer · 2014-03-26 20:23:55

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

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

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

Antonio · Accepted Answer · 2017-04-12 11:26:41

Yo можно использовать в WebApiConfig.cs:
config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));

Netferret · Accepted Answer · 2017-07-24 11:40:29

Это правильный набор заголовков. Кажется немного более элегантным.
public JsonResult<string> TestMethod() 
{
return Json("your string or object");
}

Carlo Saccone · Accepted Answer · 2018-09-26 14:10:41

для тех, кто использует OWIN

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

становится (при запуске.cs):

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

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

            [...]
        }