如何强制ASP.NET Web API始终返回JSON?

Bor*_*ard 103 asp.net-mvc asp.net-web-api

ASP.NET Web API默认执行内容协商 - 将根据Accept标头返回XML或JSON或其他类型.我不需要/想要这个,有没有办法(比如属性或东西)告诉Web API总是返回JSON?

Fil*_*p W 165

清除所有格式化程序并添加Json格式化程序.

GlobalConfiguration.Configuration.Formatters.Clear();
GlobalConfiguration.Configuration.Formatters.Add(new JsonMediaTypeFormatter());
Run Code Online (Sandbox Code Playgroud)

编辑

我把它添加到Global.asax里面Application_Start().

  • @TienDo - 链接到菲利普自己的博客? (7认同)
  • 菲利普W现在变得更好了:),请看http://www.strathweb.com/2013/06/supporting-only-json-in-asp-net-web-api-the-right-way/ (6认同)

Dmi*_*lov 76

仅支持ASP.NET Web API中的JSON - 正确的方法

用JsonContentNegotiator替换IContentNegotiator:

var jsonFormatter = new JsonMediaTypeFormatter();
//optional: set serializer settings here
config.Services.Replace(typeof(IContentNegotiator), new JsonContentNegotiator(jsonFormatter));
Run Code Online (Sandbox Code Playgroud)

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"));
    }
}
Run Code Online (Sandbox Code Playgroud)

  • 代码的第一部分在哪里被剪切和粘贴?我在Global.asax中没有看到"config"对象.变量来自哪里?这篇文章也没有解释. (4认同)
  • 检查WebApiConfig.cs文件中的public static void Register(HttpConfiguration config){...}方法,该文件已由VS2012在项目创建时生成 (3认同)
  • 这打破了我的swashbuckle集成,它似乎与github上的这个问题有关(https://github.com/domaindrivendev/Swashbuckle/issues/219).我想使用这个方法,但下面使用`GlobalConfiguration ... Clear()`实际上有效. (2认同)

JJ_*_*ire 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());
        }
    }
}
Run Code Online (Sandbox Code Playgroud)


Bat*_*mer 8

GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();
Run Code Online (Sandbox Code Playgroud)

这会清除XML格式化程序,从而默认为JSON格式.