ASP.Net Core Web API Controller action with many parameters

Question

I have ASP.Net Core Web API Controller's method that returns List<Car> based on query parameters.

[HttpPost("cars")]
public async Task<List<Car>> GetCars([FromBody] CarParams par)
{
    //...
}

Parameters are grouped in record type CarParams. There are about 20 parameters:

public class CarParams
{
    public string EngineType { get; set; }
    public int WheelsCount { get; set; }
    /// ... 20 params
    public bool IsTruck { get; set; }
}

I need to change this method from POST to GET, because I want to use a server-side caching for such requests.

Should I create a controller's method with 20 params?

[HttpGet("cars")]
public async Task<List<Car>> GetCars(string engineType, 
                                      int wheelsCount, 
                                  /*...20 params?...*/
                                         bool isTruck)
{
    //...
}

If this is the case: Is there a way to automatically generate such a complex URL for a client-side app?

You are aware of the URL length limitation?

TomTom
– TomTom

2018-06-17 21:11:12 +00:00
Commented Jun 17, 2018 at 21:11 — TomTom
– TomTom, Commented Jun 17, 2018 at 21:11

Nkosi · Accepted Answer · 2018-06-17 21:04:58Z

6

You can keep the model. Update the action's model binder so that it knows where to look for the model data.

Use [FromQuery] to specify the exact binding source you want to apply.

[HttpGet("cars")]
[Produces(typeof(List<Car>))]
public async Task<IActionResult> GetCars([FromQuery] CarParams parameters) {

    //...

    return Ok(data);
}

Reference Model Binding in ASP.NET Core

answered Jun 17, 2018 at 21:04

Nkosi

249k38 gold badges472 silver badges506 bronze badges

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

4 Comments

AsValeO Over a year ago

[Produces(typeof(List<Car>))] attribute required because return type of method is Task<IActionResult>? ASP.NET Core introduces IActionResult<T>, so this attribute will not be required anymore?

AsValeO Over a year ago

How request URL should look like for this controller, please provide example. Is there a way to generate URL with query params from given CarParams object?

AsValeO Over a year ago

I've found a QueryBuilder class.

Imran Javed Over a year ago

Just for reference URL may look like following: localhost:12345/api/controllerName/… While Model Binding will map values to properties of parameter type.

Giorgi Chkhikvadze · Accepted Answer · 2018-06-17 19:36:09Z

1

Just change [FromBody] attribute with [FromUrl]

answered Jun 17, 2018 at 19:36

Giorgi Chkhikvadze

7146 silver badges16 bronze badges

Collectives™ on Stack Overflow

ASP.Net Core Web API Controller action with many parameters

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