Comment définir des paramètres JsonSerializerSettings personnalisés pour Json.NET dans l'API Web ASP.NET ?

Question

Je comprends que l'API Web ASP.NET utilise nativement Json.NET pour la (dé)sérialisation des objets, mais existe-t-il un moyen de spécifier une JsonSerializerSettings que vous voulez qu'il utilise ?

Par exemple, si je voulais inclure type dans la chaîne JSON sérialisée ? Normalement, j'injecterais les paramètres dans la chaîne .Serialize() mais l'API Web le fait en silence. Je ne trouve pas de moyen d'injecter les paramètres manuellement.

Answer 1

Vous pouvez personnaliser le JsonSerializerSettings en utilisant le Formatters.JsonFormatter.SerializerSettings dans le HttpConfiguration objet.

Par exemple, vous pouvez le faire dans la méthode Application_Start() :

protected void Application_Start()
{
    HttpConfiguration config = GlobalConfiguration.Configuration;
    config.Formatters.JsonFormatter.SerializerSettings.Formatting =
        Newtonsoft.Json.Formatting.Indented;
}

Answer 2

Vous pouvez spécifier JsonSerializerSettings pour chaque JsonConvert et vous pouvez définir une valeur par défaut globale.

Simple JsonConvert avec une surcharge :

// Option #1.
JsonSerializerSettings config = new JsonSerializerSettings { ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore };
this.json = JsonConvert.SerializeObject(YourObject, Formatting.Indented, config);

// Option #2 (inline).
JsonConvert.SerializeObject(YourObject, Formatting.Indented,
    new JsonSerializerSettings() {
        ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore
    }
);

Réglage global avec le code dans Application_Start() dans Global.asax.cs :

JsonConvert.DefaultSettings = () => new JsonSerializerSettings {
     Formatting = Newtonsoft.Json.Formatting.Indented,
     ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore
};

Référence : https://github.com/JamesNK/Newtonsoft.Json/issues/78

Answer 3

La réponse est d'ajouter ces 2 lignes de code à la méthode Application_Start de Global.asax.cs

var json = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
json.SerializerSettings.PreserveReferencesHandling = 
    Newtonsoft.Json.PreserveReferencesHandling.All;

Référence : Gestion des références d'objets circulaires