จะบังคับให้ ASP.NET Web API ส่งคืน JSON ได้อย่างไร

ASP.NET Web API ทำการเจรจาเนื้อหาตามค่าเริ่มต้น - จะส่งคืน XML หรือ JSON หรือประเภทอื่น ๆ ตามAcceptส่วนหัว ฉันไม่ต้องการ / ต้องการสิ่งนี้มีวิธี (เช่นแอตทริบิวต์หรืออะไรบางอย่าง) เพื่อบอกให้ Web API ส่งคืน JSON เสมอหรือไม่

รองรับเฉพาะ JSON ใน ASP.NET Web API - THE RIGHT WAY

แทนที่ 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"));
    }
}

ล้างฟอร์แมตทั้งหมดและเพิ่มตัวจัดรูปแบบ Json กลับ

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

แก้ไข

ผมเพิ่มไปยังภายในGlobal.asaxApplication_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

แรงบันดาลใจจากคำตอบที่ยอดเยี่ยมของ Dmitry Pavlov ฉันปรับเปลี่ยนเล็กน้อยเพื่อให้ฉันสามารถเสียบฟอร์แมตใดก็ได้ที่ฉันต้องการบังคับใช้

เครดิต Dmitry

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

คุณสามารถใช้ใน WebApiConfig.cs:

config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html"));

สำหรับผู้ที่ใช้ 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());

            [...]
        }