Як змусити веб-API ASP.NET завжди повертати JSON?


103

ASP.NET Web API здійснює узгодження контенту за замовчуванням - поверне XML або JSON або інший тип на основі Acceptзаголовка. Мені це не потрібно / хочу, чи є спосіб (наприклад, атрибут чи щось), щоб сказати Web 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
Перевірте публічний статичний недійсний реєстр (HttpConfiguration config) {...} метод у файлі WebApiConfig.cs, який було створено VS2012 при створенні проекту
Дмитро Павлов

Чи змусить це JSON у тому сенсі, що клієнт із AcceptXML отримає JSON, а не отримає 406 ?
Люк Пуплетт

1
Я можу відповісти на власний коментар / питання: він повертає XML незалежно від Acceptзаголовка.
Люк Пуплетт

2
Це порушує мою інтеграцію, і, здається, це пов'язано з цим питанням на github ( github.com/domaindrivendev/Swashbuckle/isissue/219 ). Я хотів би скористатися цим методом, але той, що використовується нижче, GlobalConfiguration...Clear()фактично працює.
seangwright

167

Очистіть усі формати та додайте формат Json назад.

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

EDIT

Я додав його Global.asaxвсередину Application_Start().


і в якому файлі .. ?? global.ascx .. ??
shashwat

У вашому методі Application_Start ()
Джафін

6
Filip W зараз просто покращився :), дивіться це тут strathweb.com/2013/06/…
Tien Do

7
@TienDo - посилання на власний блог Філіпа?
Філ

10

Philip W отримав правильну відповідь, але для ясності та повного робочого рішення відредагуйте файл 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());
        }
    }
}

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

Це очищає формат XML і тим самим дефолт у форматі JSON.


Ідеально все, що потрібно
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/…
Елізабет


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

            [...]
        }
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.