Set default format of web API response (ASP.NET Core)

Question

I have a web API in ASP.NET Core 2. I am using FormatFilter as defined in https://andrewlock.net/formatting-response-data-as-xml-or-json-based-on-the-url-in-asp-net-core/

I have a function defined like this:

[HttpGet("/api/Values/{userKey}/{variableKey}/GetValue")]
[HttpGet("/api/Values/{userKey}/{variableKey}/GetValue.{format}"), FormatFilter]
public async Task<string> GetValue(string userKey, string variableKey)

In Startup I have:

    services.AddMvc(options =>
    {
        options.FormatterMappings.SetMediaTypeMappingForFormat("xml", "application/xml");
        options.FormatterMappings.SetMediaTypeMappingForFormat("js", "application/json");
    })
    .AddXmlSerializerFormatters();

It works fine except that I'd like the default format to be XML and not json when I call /GetValue.

I still wish to continue getting json when I call /GetValue.js and XML when I call /GetValue.xml

I cannot find any doc on how to make XML the default format. How can I achieve this?

The function returns a simple string, which correctly gets xml or json formatted. — pdube
– pdube, Commented Dec 9, 2017 at 22:35
maybe you can write a simple middleware that force the Accept-Content header to application/xml if the Accept.Content header is not set or doesn't contains application/json — agua from mars
– agua from mars, Commented Dec 9, 2017 at 23:27
Try clearing formaters collection and add them back in right order (first default then other). stackoverflow.com/questions/20191980/… — Matjaž
– Matjaž, Commented Dec 10, 2017 at 7:34

pdube · Accepted Answer · 2017-12-11 13:47:40Z

2

We can pass a default value to a placeholder, so I changed a little the format of the URL and made it like this:

[HttpGet("/api/Values/{userKey}/{variableKey}/GetValue/{format=xml}"), FormatFilter]

Then /GetValue returns xml formatted

/GetValue/xml returns xml formatted

/GetValue/js returns json formatted

answered Dec 11, 2017 at 13:47

pdube

6632 gold badges13 silver badges28 bronze badges

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

Collectives™ on Stack Overflow

Set default format of web API response (ASP.NET Core)

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related