how we can design .net core api controller to accept an array value of strings

Question

I would like to know how we can design .net core api controller to accept an array value like given below

http://localhost:32656/api/Values?str[]="abc"&str[]="xyz"

I did some research online and the only two options, I was able to find is either I need to pass indexes inside the array eg:- http://localhost:32656/api/Values?str[0]="abc"&str[1]="xyz" (Pass indexes inside the array)

or I need to pass the array as repeated query strings. eg:- http://localhost:32656/api/Values?str="abc"&str="xyz" (Pass it as repeated query strings)

But I would like to see the other possible options to send an array to .net core 2.1 api controller.

Kirk Larkin · Accepted Answer · 2019-01-10 19:27:45Z

3

You can take advantage of the FromQuery attribute here, specifying the Name property as str[]:

public IActionResult Values([FromQuery(Name = "str[]")] List<string> strValues)
{
    ...
}

If you also want to strip out the "s for each value, you can use a Select. Here's a an example:

public IActionResult Values([FromQuery(Name = "str[]")] List<string> strValues)
{
    var strValuesWithoutQuotes = strValues.Select(x => x.Trim('"'));

    ...
}

answered Jan 10, 2019 at 19:27

Kirk Larkin

94.4k17 gold badges235 silver badges214 bronze badges

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

Comments

Cale · Accepted Answer · 2019-01-10 18:00:47Z

0

Here is how we do it:

[Route("api/v1/[controller]")]
public class TestController : Controller
{
    [HttpGet]
    public async Task Get(List<string> stringValues)
    {
        ...
    }
}

Then call the endpoint with http://localhost/api/v1/test?stringValues=string1&stringValues=string2

stringValues should have the list of values in the query string

answered Jan 10, 2019 at 18:00

Cale

6471 gold badge8 silver badges18 bronze badges

3 Comments

Ane Over a year ago

Thanks Cale for the quick reply. This is how I am currently doing. But I need to change the api call in to this format. localhost:32656/api/…" . I need to add square brackets in to the URL. Thanks.

Cale Over a year ago

are you unable to update the calling system? I haven't seen that url syntax before, and I am not sure .net core will support it

Ane Over a year ago

Unfortunately I am not able to change the calling system. Thanks for your support. Have a great day.

Collectives™ on Stack Overflow

how we can design .net core api controller to accept an array value of strings

2 Answers 2

Comments

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related