Optional Parameter in GET Requests for ASP.NET Core API not Working with Swagger

Question

I'm working on an endpoint which looks like this:

GET {{url}}/v1.0/GroupsInfo/StuffToGet/1/2/hea

where the 2 integers are certain ids and the text on the end is a search term.

I want the last parameter (the search text) to be optional. I have got that working using the following, but it does not appear as mandatory in Swagger:

[Route("[action]/{catId:int}/{dogId:int}/{search?}")]
public IActionResult StuffToGet(int catId, int dogId, string search)
{
    // do stuff
}

Swagger is ignoring the question mark on the end of the Search parameter in the route constraint.

Is this a known issue, or do I need to right some custom code to get Swagger to recognise that optional flag?

@Serge Sorry. I need to re-phrase my question. You are correct. It does work. However, it does not work with Swagger. Swagger makes it a mandatory parameter. Will edit question now. — onefootswill
– onefootswill, Commented Jul 20, 2021 at 1:02

Serge · Accepted Answer · 2021-07-20 01:21:09Z

1

your variant will be working, but if you have a problem with swagger try this

[Route("[action]/{catId:int}/{dogId:int}]
[Route("[action]/{catId:int}/{dogId:int}/{search}")]
public IActionResult StuffToGet(int catId, int dogId, string search)
{
    // do stuff
}

or maybe this


[Route("StuffToGet/{catId:int}/{dogId:int}/{search}")]
public IActionResult StuffToGet(int catId, int dogId, string search)
{
    // do stuff
}
[Route("StaffToGet/{catId:int}/{dogId:int}]
public IActionResult StuffToGet(int catId, int dogId)
{
   return StuffToGet(catId, dogId,string.empty);
}

edited Jul 20, 2021 at 1:21

answered Jul 20, 2021 at 1:05

Serge

44.4k4 gold badges26 silver badges53 bronze badges

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

4 Comments

onefootswill Over a year ago

I did try that. It added a second textbox for the search variable in the Swagger interface, but it kept the mandatory textbox for the search variable as well.

onefootswill Over a year ago

Sorry, I got that wrong, it created a whole new endpoint, but the "try it out" section still contained the mandatory search parameter textbox, even though it was not in the actual url signature for that endpoint.

onefootswill Over a year ago

Yeah. That's it. A pity you have to create a whole new endpoint. But it works.

Serge Over a year ago

Yes, sometimes swagger makes strange stuff.

Rosdi Kasim · Accepted Answer · 2021-07-20 00:42:09Z

1

Create two actions with similar routes, but one without the search parameter. Both actions call the same business layer code.

answered Jul 20, 2021 at 0:42

Rosdi Kasim

26.4k25 gold badges139 silver badges165 bronze badges

Collectives™ on Stack Overflow

Optional Parameter in GET Requests for ASP.NET Core API not Working with Swagger

2 Answers 2

4 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related