How do I use HttpGet attribute with multiple input parameters ? (and work with swagger)

Question

It works fine with the code below is I only have one parameter but how do I do TWO input parameters? If I just use [HttpGet] then none of the parameters are send though it works fine outside of Swagger. Help ?

//[HttpGet]
[Consumes("application/json")]
[HttpGet("{caseId}")]
public ActionResult Get(string caseId, string fileName)
{
    return null;
}

why you don't use a ViewModel instead of those 2 parameters? — Cristian Szpisjak
– Cristian Szpisjak, Commented Oct 21, 2016 at 17:26
The resource can be identified using caseId and fileName together? Is that correct? — Silly John
– Silly John, Commented Oct 21, 2016 at 18:26
I'm not sure if I understood well your question. You want your get method to receive both parameteres, and show it in Swashbuckle? — Rafael Marques
– Rafael Marques, Commented Oct 21, 2016 at 18:29

jimpaine · Accepted Answer · 2016-10-22 20:13:52Z

3

Try using the FromUri or querystring attributes in your method signature

[Consumes("application/json")]
[HttpGet("{caseId}")]
public ActionResult Get(string caseId, [FromUri] string fileName)
{
    return null;
}

or

[Consumes("application/json")]
[HttpGet("{caseId}")]
public ActionResult Get(string caseId, [QueryString] string fileName)
{
    return null;
}

This should now document in swagger showing that the caseId is part of the route and that the fileName should be specified.

edited Oct 22, 2016 at 20:13

answered Oct 22, 2016 at 19:55

jimpaine

8876 silver badges11 bronze badges

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

1 Comment

punkouter Over a year ago

Is the best practice to use a ViewModel for anything more than one input parameter

Robert Altman · Accepted Answer · 2020-07-01 19:06:45Z

1

I was just experimenting with this.

I found the following code works with Swagger:

[HttpGet("{entityId}/{monthsOfHistory}")]
public async Task<ActionResult<DateTime>> GetAsync([FromRoute] int entityId, [FromRoute] int monthsOfHistory)

answered Jul 1, 2020 at 19:06

Robert Altman

5,5755 gold badges35 silver badges52 bronze badges

Collectives™ on Stack Overflow

How do I use HttpGet attribute with multiple input parameters ? (and work with swagger)

2 Answers 2

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related