Comment changer l'API Web 2 par défaut en formateur JSON?

J'ai un projet d'API Web qui retourne des données de produit. Il négocie le type de retour correctement en fonction de l'en-tête Accept (JSON/XML) de la demande. Le problème est que, si aucun en-tête Accept est spécifié, retourne XML, mais je le veux de retour JSON par défaut

http://website.com/MyPage?type=json //returns json
http://website.com/MyPage?type=xml //returns xml
http://website.com/MyPage //returns xml by default

Voici mon code actuel ressemble:

GlobalConfiguration.Configuration.Formatters.XmlFormatter.MediaTypeMappings.Add(
new QueryStringMapping("type", "xml", new MediaTypeHeaderValue("application/xml")));

GlobalConfiguration.Configuration.Formatters.JsonFormatter.MediaTypeMappings.Add(
new QueryStringMapping("type", "json", new MediaTypeHeaderValue("application/json")));

source d'informationauteur Nick Kahn

  1. 17

    Ajouter ceci dans votre App_Start/WebApiConfig.cs:

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

    Je pense que l'API Web utilise le premier module de formatage, il peut en trouver dans les Formateurs de la collection. Vous pouvez modifier l'ordre avec quelque chose comme

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

    Mais il semble que le JSON formateur doit être la première par défaut, de sorte que vous pourriez vouloir vérifier si vous êtes déjà en train de changer cette collection quelque part.

  3. 6

    Je pense que vous devriez changer de la manière suivante.

        /*Response as default json format
     * example (http://localhost:9090/WebApp/api/user/)
     */
    GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();

    /*Response as json format depend on request type
     * http://localhost:9090/WebApp/api/user/?type=json
     */
    GlobalConfiguration.Configuration.Formatters.JsonFormatter.MediaTypeMappings.Add(
    new QueryStringMapping("type", "json", new MediaTypeHeaderValue("application/json")));

    /*Response as xml format depend on request type
     * http://localhost:9090/WebApp/api/user/?type=xml
     */
    GlobalConfiguration.Configuration.Formatters.XmlFormatter.MediaTypeMappings.Add(
    new QueryStringMapping("type", "xml", new MediaTypeHeaderValue("application/xml")));
  4. 5

    Ou tout simplement supprimer le XmlFormatter

    var formatters = GlobalConfiguration.Configuration.Formatters;
formatters.Remove(formatters.XmlFormatter);
  5. 3

    Aucune des réponses ci-dessus, a travaillé pour moi. Le problème était que je commençais à tenir des formateurs de GlobalConfiguration et pas le config objet créé avec new HttpConfiguration() Voici le code qui fonctionne pour moi :

    public class WebApiConfig
{
    public static HttpConfiguration Register()
    {

        var config = new HttpConfiguration();
        //This next line could stay if you want xml formatting
        config.Formatters.Remove(config.Formatters.XmlFormatter);

        //This next commented out line was causing the problem
        //var jsonFormatter = GlobalConfiguration.Configuration.Formatters.JsonFormatter;

        //This next line was the solution
        var jsonFormatter = config.Formatters.JsonFormatter;
        jsonFormatter.UseDataContractJsonSerializer = false; //defaults to false, but no harm done
        jsonFormatter.SerializerSettings.DateFormatHandling = DateFormatHandling.IsoDateFormat;
        jsonFormatter.SerializerSettings.Formatting = Formatting.None;
        jsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();           

        //remaining irrelevant code commented out
        return config;
    }
}
  6. 0
    config.EnableSystemDiagnosticsTracing();

GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();

//Adding formatter for Json   
config.Formatters.JsonFormatter.MediaTypeMappings.Add(new QueryStringMapping("type", "json", new MediaTypeHeaderValue("application/json")));

//Adding formatter for XML   
config.Formatters.XmlFormatter.MediaTypeMappings.Add(new QueryStringMapping("type", "xml", new MediaTypeHeaderValue("application/xml")));