Верните xml или json из MVC web api на основе запроса

Учитывая следующий webapiconfig;

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

и этот контроллер;

  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;
        }
    }

Использование URL http://localhost/api/Products Я получаю список продуктов в формате XML.

Мне хотелось бы иметь возможность возвращать json или xml на основе запроса. Итак, для json это будет:

http://localhost/api/Products.json

а для XML это будет:

http://localhost/api/Products.xml

также

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

Возможно ли это и как я могу достичь этой функциональности?

Альтернативой может быть что-то вроде:

http://localhost/api/json/Products/

Ответы

Ответ 1

Да, вы можете достичь этого с помощью AddUriPathExtensionMapping

Вы можете создавать маршруты следующим образом:

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 }
);

Затем вам нужно расширить форматы:

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

Можете добавить ссылку на System.Net.Http.Formatting, так как эти методы являются методами расширения, а intellisense не увидит их по умолчанию.

Помните, что в этом примере вам все равно придется выдать запрос с соответствующим типом содержимого. Однако, если вы хотите, чтобы они были напрямую доступны через адресную строку браузера, вы можете перейти к "text/html".

Я написал сообщение в блоге обо всем, что некоторое время назад - что должно быть полезно, и введем вас в подробности http://www.strathweb.com/2012/04/different-mediatypeformatters-for-same-mediaheadervalue-in-asp-net-web-api/