Same Web API return multiple formats

Question

I am working on a Asp.Net Web API project, where I need to create it in a way so that 2 different clients can consume it and get response in there desired formats.

Need to provide support for both JSON and XML formats.

I have tried something in Register method in WebApiConfig file:

public static void Register(HttpConfiguration config)  
{  
    // 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")));  
}

Here client can consume API but need to pass query string type=json or xml to get response in desired format.

http://localhost:1312/api/Blog?type=xml
http://localhost:1312/api/Blog?type=json

Is there a better way to detect client's desired format and respond accordingly? If we get it from header of request or something like that, TIA.

Use Content-Type header to detect the incoming request format also you can use Accept header to decide what type of response to send — Chetan
– Chetan, Commented Jul 19, 2021 at 5:45

ebattulga · Accepted Answer · 2021-07-19 05:58:46Z

1

Asp.net ApiController automatically do this

For example:

After that add Accept header just like this

edited Jul 19, 2021 at 5:58

answered Jul 19, 2021 at 5:53

ebattulga

11.1k20 gold badges81 silver badges119 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

Sunil Chaudhry Over a year ago

thanks for the response @ebattulga, we can add Accept in ajax call, can we add the same in angular httpclient or need to do handle that separately?

ebattulga Over a year ago

@SunilChaudhry of course can add Accept header in different clients (HttpClient, Angular, Javascript ...etc ). If you want, you can handle header from your action of controller.

Sunil Chaudhry Over a year ago

thanks @ebattulga, as you said APIController itself take care of requested format, then its required only from client to add it in Accept header of request and no need to do anything from API side, right?

Sunil Chaudhry Over a year ago

I am getting always JSON, tried with Access header as application/xml. DO you have any idea how to fix it? Also is there a way to always return JSON if no particular type is required(.)?

ebattulga Over a year ago

I can't tell you your problem without show some code. You can edit your post to add some code. After that, mention here

Collectives™ on Stack Overflow

Same Web API return multiple formats

1 Answer 1

5 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Your Answer

Sign up or log in

Post as a guest

Related