Как заставить ASP.NET Web API возвращать данные JSON или XML на основе ввода?

Question

Я пытаюсь получить выходные данные XML или JSON на основе ввода. Я использовал приведенный ниже код API WEB, но не смог точно выполнить вывод.

public string Get(int id) 
{ 
    if (GlobalConfiguration.Configuration.Formatters.XmlFormatter == null) 
    { 
     GlobalConfiguration.Configuration.Formatters.Add(GlobalConfiguration.Configuration.Formatters.XmlFormatter); 
    } 
    if (GlobalConfiguration.Configuration.Formatters.JsonFormatter == null) 
    { 
     GlobalConfiguration.Configuration.Formatters.Add(GlobalConfiguration.Configuration.Formatters.JsonFormatter); 
    } 
    if (id == 1) 
    { 
     GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.JsonFormatter);     
     GlobalConfiguration.Configuration.Formatters.XmlFormatter.UseXmlSerializer = true;     
    } 
    else 
    { 
     GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter); 
     GlobalConfiguration.Configuration.Formatters.JsonFormatter.UseDataContractJsonSerializer = true; 
    } 
    return "value"; 
} 

Answer 1

Добавить ниже код app_start событие в global.asax файле. В API Url добавить строку запроса:

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

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

.: например

for xml : http://localhost:49533/api/?type=xml 

for json: http://localhost:49533/api/?type=json 

Answer 2

То, что вы пытаетесь сделать, не будет работать в многопоточной среде. Вы не можете добавлять и удалять из коллекции форматировщиков по запросу. Вот лучший способ выполнить то, что вы хотите.

public HttpResponseMessage Get(int id) 
{ 
    Foo foo = new Foo(); 
    var content = new ObjectContent<Foo>(foo, 
        ((id == 1) ? Configuration.Formatters.XmlFormatter : 
           Configuration.Formatters.JsonFormatter)); 
    return new HttpResponseMessage() 
    { 
     Content = content 
    }; 
} 

Answer 3

Если запрос определяет тип MIME, например application/json, то веб-апи будет формат ответа соответственно.

Если вы пытаетесь отлаживать свой веб-api вручную, используйте для этого тип инструмента Fiddler 2.

This article описывает концепцию.

Answer 4

QueryStringMapping` является хорошим решением, но мне нужно значение по умолчанию для типа.

для XML: localhost:49533/api/?type=xml

для JSON: localhost:49533/api/

Я решить эту ситуацию так:

GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear(); 
var jSettings = new JsonSerializerSettings(); 

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings = jSettings; 
GlobalConfiguration.Configuration.Formatters.XmlFormatter.MediaTypeMappings.Add(new QueryStringMapping("xml", "true", new MediaTypeHeaderValue("application/xml"))); 

Answer 5

Хотя принятый ответ на vijayjan15 кажется, что лучший способ пойти для вашей конкретной ситуации (то есть, используя MediaTypeMappings), вы можете альтернативно иметь два разных метода: один, который возвращает XML, и тот, который возвращает JSON. Чтобы сделать это, вы можете создать экземпляр контроллера конкретных HttpConfiguration (во избежание изменения в один GlobalConfiguration.Configuration):

public MyReturnType GetMyTypeAsXml() { 
    Configuration = new HttpConfiguration(); 
    Configuration.Formatters.Clear(); 
    Configuration.Formatters.Add(new XmlMediaTypeFormatter()); 

    return new MyReturnType(); 
} 

public MyReturnType GetMyTypeAsJson() { 
    Configuration = new HttpConfiguration(); 
    Configuration.Formatters.Clear(); 
    Configuration.Formatters.Add(new JsonMediaTypeFormatter()); 

    return new MyReturnType(); 
} 

я не уверен, сколько над головой есть в раскручивается новый экземпляр HttpConfiguration (Я подозреваю, что не много), но новый экземпляр поставляется с сборкой Formatters, заполненной по умолчанию, поэтому вам нужно очистить ее сразу после ее создания. Обратите внимание, что если вы не используете, используйте Configuration = new HttpConfiguration(), а вместо этого измените конфигурацию напрямую, она изменит свойство GlobalConfiguration.Configuration (так что это повлияет на все ваши другие методы WebApi - плохо!).

Answer 6

Посмотрел на это немного больше, и нашел ответ в another post:

public HttpResponseMessage Get(int id) 
{ 
    string content = "value"; 

    if (id == 1) 
    { 
     return Request.CreateResponse<string>(HttpStatusCode.OK, content, Configuration.Formatters.JsonFormatter); 
    } 

    return Request.CreateResponse<string>(HttpStatusCode.OK, content, Configuration.Formatters.XmlFormatter); 
} 

Answer 7

Он также работает, чтобы заставить ПРИНЯТЬ заголовки. Отличный вариант, если вы не всегда возвращаетесь HttpResponseMessage's. Я.е

Request.Headers.Add("Accept", "text/json"); 
return Request.CreateResponse(HttpStatusCode.OK, yourobject); 

или

Request.Headers.Add("Accept", "application/xml"); 
return new Rss20FeedFormatter(feed);