Retour au format xml ou json de MVC, web api basées sur demande

Le suivant webapiconfig;

config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

et ce contrôleur

  public class ProductsController : ApiController
    {
         Product[] _products = new Product[] 
        { 
            new Product { Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1 }, 
            new Product { Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M }, 
            new Product { Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M } 
        };

        public IEnumerable<Product> GetAllProducts()
        {
            return _products;
        }
    }

À l'aide de l'URL http://localhost/api/Products je obtenir une liste des produits au format XML.

Ce que j'aimerais, c'est avoir la possibilité de retourner format json ou xml basé sur la demande. Donc, pour json, il serait;

http://localhost/api/Products.json

et pour XML, il serait;

http://localhost/api/Products.xml

de même;

http://localhost/api/Products.json/1/
http://localhost/api/Products.xml/1/

Est-ce possible et comment puis-je obtenir cette fonctionnalité?

Une alternative serait quelque chose comme;

http://localhost/api/json/Products/
InformationsquelleAutor ChrisBint | 2012-10-24
  1. 38

    Oui, vous pouvez le faire avec AddUriPathExtensionMapping

    Vous pouvez créer des itinéraires, comme ceci:

    routes.MapHttpRoute(
  name: "Api UriPathExtension",
  routeTemplate: "api/{controller}.{extension}/{id}",
  defaults: new { id = RouteParameter.Optional, extension = RouteParameter.Optional }
);

routes.MapHttpRoute(
  name: "Api UriPathExtension ID",
  routeTemplate: "api/{controller}/{id}.{extension}",
  defaults: new { id = RouteParameter.Optional, extension = RouteParameter.Optional }
);

    Alors vous avez besoin d'étendre les formateurs:

      config.Formatters.JsonFormatter.AddUriPathExtensionMapping("json", "application/json");
  config.Formatters.XmlFormatter.AddUriPathExtensionMapping("xml", "text/xml");

    Assurez-vous d'ajouter une référence à System.Net.Http.Formatting, que ces méthodes sont des méthodes d'extension et de l'intellisense ne les vois pas par défaut.

    Rappelez-vous dans cet exemple, vous avez encore à la question de la demande avec le content-type approprié. Toutefois, si vous voulez avoir ces directement accessibles via la barre d'adresse du navigateur vous pouvez mapper à "text/html".

    J'ai écrit un billet de blog sur tout ce qui tout à l'heure - ce qui devrait être utile et vous faire entrer dans plus de détails http://www.strathweb.com/2012/04/different-mediatypeformatters-for-same-mediaheadervalue-in-asp-net-web-api/

    • Les routes semblent fonctionner, mais l'extension n'en rien faire. J'ai ajouté ces mondiaux.asax, est-ce un problème?
    • Chris, utiliser {ext} au lieu de {extension}, parce que {ext} semble être codée en dur de se référer à la mappé formateur.
    • Grand fil. Comme @MCattle dit, rappelez-vous Toujours: EXT au lieu de l'EXTENSION
    • est-il possible de réaliser cela avec en prenant un autre paramètre format=xml ou format=json
    • comment accepter les deux formats(xml et json) pour la requête?
    InformationsquelleAutor Filip W