ASP.NET Web APIが常にJSONを返すように強制する方法は?


103

ASP.NET Web APIはデフォルトでコンテンツのネゴシエーションを行います- Acceptヘッダーに基づいてXMLまたはJSONまたはその他のタイプを返します。これは必要ありません/必要ありません。WebAPIに常にJSONを返すように指示する方法(属性など)はありますか?


jsonを除くすべてのフォーマッターを削除すると、これを実行できる可能性がありますGlobalConfiguration.Configuration.Formatters
Claudio Redi '27

回答:


75

ASP.NET Web APIでJSONのみをサポート– 正しい方法

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
コードの最初の部分もどこにカットアンドペーストされますか?Global.asaxに "config"オブジェクトが表示されません。その変数はどこから来るのですか?記事でも説明していません。
BuddyJoe 2013

3
プロジェクトの作成時にVS2012によって生成されたWebApiConfig.csファイルのpublic static void Register(HttpConfiguration config){...}メソッドを確認してください
Dmitry Pavlov

これは、AcceptXML を使用するクライアントがJSONを取得し、406を取得しないという意味でJSONを強制しますか?
ルークプレット14年

1
私は自分のコメント/質問に答えることができます:Acceptヘッダーに関係なくXMLを返します。
ルークプレット14年

2
これは私のスワッシュバックル統合を壊し、github(github.com/domaindrivendev/Swashbuckle/issues/219)のこの問題に関連しているようです。この方法を使用したいのですが、以下の方法でGlobalConfiguration...Clear()実際に機能します。
seangwright、2015年

167

すべてのフォーマッターをクリアし、Jsonフォーマッターを再度追加します。

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

編集する

私はそれを追加Global.asax内部Application_Start()


そして、どのファイルに.. ?? global.ascx .. ??
shashwat、2013

Application_Start()メソッド内
Jafin

6
フィリップWはちょうど良い方法今:)、ここでそれを見ましたstrathweb.com/2013/06/...
ティエンドゥ

7
@TienDo-フィリップ自身のブログへのリンク?
2013

10

フィリップ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 '12年

4

Dmitry Pavlovの素晴らしい答えに触発されて、私はそれを少し変更して、強制したいフォーマッターをプラグインできるようにしました。

ドミトリーへのクレジット。

/// <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

1つのメソッドに対してのみそれを実行したい場合は、メソッドをreturnのHttpResponseMessage代わりにreturnとして宣言します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
Elisabeth


0

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

            [...]
        }
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.