ASP.NET Web API здійснює узгодження контенту за замовчуванням - поверне XML або JSON або інший тип на основі Accept
заголовка. Мені це не потрібно / хочу, чи є спосіб (наприклад, атрибут чи щось), щоб сказати Web API, щоб завжди повертати JSON?
ASP.NET Web API здійснює узгодження контенту за замовчуванням - поверне XML або JSON або інший тип на основі Accept
заголовка. Мені це не потрібно / хочу, чи є спосіб (наприклад, атрибут чи щось), щоб сказати Web API, щоб завжди повертати JSON?
Відповіді:
Підтримка лише 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"));
}
}
Accept
XML отримає JSON, а не отримає 406 ?
Accept
заголовка.
GlobalConfiguration...Clear()
фактично працює.
Очистіть усі формати та додайте формат Json назад.
GlobalConfiguration.Configuration.Formatters.Clear();
GlobalConfiguration.Configuration.Formatters.Add(new JsonMediaTypeFormatter());
EDIT
Я додав його Global.asax
всередину Application_Start()
.
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());
}
}
}
GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();
Це очищає формат XML і тим самим дефолт у форматі JSON.
Надихнувшись чудовою відповіддю Дмитра Павлова, я трохи змінив її, щоб я міг підключати будь-який формат, який я хотів застосувати.
Кредит Дмитру.
/// <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));
}
}
Якщо ви хочете зробити це лише для одного методу, тоді оголосьте свій метод як повернений, 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();
Для цього встановлені правильні заголовки. Здається трохи елегантніше.
public JsonResult<string> TestMethod()
{
return Json("your string or object");
}
для тих, хто використовує 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());
[...]
}
GlobalConfiguration.Configuration.Formatters