C# Web API Optional parameters in query string

Question

I have this piece of code in my controller:

[HttpGet]
[Route("team={team}&model={model}&date={date}&distance={distance}")]
public IHttpActionResult FindVehicle([FromUri]string team = "", [FromUri]string model = "", [FromUri]DateTime? date = null, [FromUri]double distance = 0.0)
    { }

All of the parameters of the query string can be optional, which is why I used the default values.

However, I am not sure what the route should be, since now, when I don't specify the model parameter for example, its value in the endpoint ends up being "model", and not "".

Darjan Bogdan · Accepted Answer · 2019-09-03 09:08:22Z

9

You don't have to define FromUri elements inside Route attribute, they will be bound out of the box:

[HttpGet]
[Route("route_name")]
public IHttpActionResult FindVehicle([FromUri]string team = "", [FromUri]string model = "", [FromUri]DateTime? date = null, [FromUri]double distance = 0.0)
{ 

}

If you are using, ASP.Net Core, then you should use [FromQuery] instead

answered Sep 3, 2019 at 9:08

Darjan Bogdan

3,9401 gold badge24 silver badges32 bronze badges

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

3 Comments

liqSTAR Over a year ago

But you could for better transparency and code style?

Darjan Bogdan Over a year ago

@liqSTAR definitely that's an option, it comes down to the preference and defined style indeed. In my opinion decorating params with the same attribute adds noise to the method signature. I would use it only in situation when there are different sources to bind model from. (e.g. ApiMethod([FromUri] string p1, [FromBody] string p2, [FromHeader] string p3))

mRhNs13 Over a year ago

How to pass string model as optional parameter here?

Collectives™ on Stack Overflow

C# Web API Optional parameters in query string

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related