Вернуть xml или json из веб-API MVC на основе запроса

Учитывая следующее 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/

Источник
Другие вопросы по тегам