Accessing the query string in ASP.Net Web Api?

RoutingQuery Stringasp.net Web-Api

Routing Problem Overview


I'm using the default template generated by Asp.net Web Api. I'm working with the Get() Part:

        // GET api/values
    public IEnumerable<string> Get()
    {
        return new string[] { "value1", "value2" };
    }

For some reason the i thought the only thing you had to do to access to query string was just to create an input string variable. So i created one more function (the only change i made) to the default controller generated:

        public IEnumerable<string> Get(string queryString)
    {
        return new string[] { "value3", "value4" };
    }

I put a break point in both methods but even if i add a query string it always goes to the function with no parameters. So if i go to http://mybaseurl/api/values?foo=f it still is going to Get() instead of get(string queryString). Does it not work the way i thought? I know i can access the query string in the Get() function using Request.RequestUri.ParseQueryString(); but i prefer to have it separated like this if possible.

Routing Solutions


Solution 1 - Routing

Even though @Kiran Challa's answer is correct, there are few situations that you might prefer to get URL parameters directly from the URL. in those scenarios, try this:

using System.Net.Http;

var allUrlKeyValues = ControllerContext.Request.GetQueryNameValuePairs();

string p1Val = allUrlKeyValues.LastOrDefault(x => x.Key == "p1").Value;
string p2Val = allUrlKeyValues.LastOrDefault(x => x.Key == "p2").Value;
string p3Val = allUrlKeyValues.LastOrDefault(x => x.Key == "p3").Value;

Now for the following URL, p1Val will be "Apple", p2Val will be "Banana", and p3Val will be null.

.../api/myController?p1=Apple&p2=Banana

Update:

Thanks for the suggestions, now, the source code for this test is in GitHub and it also runs and can be tested on Azure:

Solution 2 - Routing

The query string key name should match the parameter name of the action:

/api/values?queryString=f

public IEnumerable<string> Get(string queryString)
    {
        return new string[] { "value3", "value4" };
    }

Solution 3 - Routing

There is one more way to get query string as shown below when you are using wildcard in route or for dynamic routes.

string query = ControllerContext.HttpContext.Request.QueryString.Value;

BONUS:)

string path = ControllerContext.HttpContext.Request.Path.ToUriComponent();

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
Questioncoding4funView Question on Stackoverflow
Solution 1 - RoutingTohidView Answer on Stackoverflow
Solution 2 - RoutingKiranView Answer on Stackoverflow
Solution 3 - RoutingPranavView Answer on Stackoverflow