How to restrict a WebApi route parameter based on an array of possible values

Question

I am building a WebApi v.2 method for the following route:

[Route("api/{entityName}/logo/{entityId}/{size:char}")]
public HttpResponseMessage GetLogo(string entityName, string entityId, char size) {...}

Now, I need to restrict size parameter to one of three characters: s, m, l. If size is not one of those, I don't want this route to be matched.

Is it possible?

Community · Accepted Answer · 2017-05-23 12:14:34Z

2

I am thinking that something like this may work

  [Route("api/{entityName}/logo/{entityId}/{size:regex(^[sml]?$)}")]

You can add a contstraint to a direct route using Shorthand References for Constraint Classes Used in Direct Route Templates.

A full list of the shorthand direct route regular expression classes can be found here

http://www.asp.net/web-api/overview/web-api-routing-and-actions/attribute-routing-in-web-api-2#constraints

Stack overflow previous question similar topic Regex in Route attribute - RESTful API ASP.NET Web API

edited May 23, 2017 at 12:14

CommunityBot

11 silver badge

answered Aug 28, 2015 at 17:17

Bill

1,2821 gold badge19 silver badges29 bronze badges

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

1 Comment

Andrey Over a year ago

That's awesome, exactly what I was looking for. Thank you!

Collectives™ on Stack Overflow

How to restrict a WebApi route parameter based on an array of possible values

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related