Passing an Array or List to @Pathvariable - Spring/Java

Question

I am doing a simple 'get' in JBoss/Spring. I want the client to pass me an array of integers in the url. How do I set that up on the server? And show should the client send the message?

This is what I have right now.

@RequestMapping(value="/test/{firstNameIds}", method=RequestMethod.GET)
@ResponseBody
public String test(@PathVariable List<Integer> firstNameIds)
{
     //What do I do??
     return "Dummy"; 
}

On the client I would like to pass something like

http://localhost:8080/public/test/[1,3,4,50]

When I did that I get an error:

java.lang.IllegalStateException: Could not find @PathVariable [firstNameIds] in @RequestMapping

You might need to use New Spring 3 UI Field Formatting static.springsource.org/spring/docs/3.0.0.RC1/reference/html/… — Santosh Gokak
– Santosh Gokak, Commented Mar 8, 2012 at 19:10

atamanroman · Accepted Answer · 2014-03-10 11:22:20Z

96

GET http://localhost:8080/public/test/1,2,3,4

@RequestMapping(value="/test/{firstNameIds}", method=RequestMethod.GET)
@ResponseBody
public String test(@PathVariable String[] firstNameIds)
{
    // firstNameIds: [1,2,3,4]
    return "Dummy"; 
}

(tested with Spring MVC 4.0.1)

answered Mar 10, 2014 at 11:22

atamanroman

11.9k8 gold badges61 silver badges83 bronze badges

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

6 Comments

Priyal Over a year ago

Does jersey support this pattern?

MiniSu Over a year ago

Yes ,Jersey supports this but in different way using PathSegment

袁文涛 Over a year ago

Failed to convert value of type 'java.lang.String' to required type 'java.lang.Long'; nested exception is java.lang.NumberFormatException: For input string: "20056,20056"

spyro Over a year ago

But how to distinguish between /{id} and /{ids}? Tried to do it like @GetMapping(value=["""/{id:\d+}"""]) and @GetMapping("""/{ids:\d+[,\d+]+}""") but now Spring tells me that my-url/123 is ambigous (which isn't the case)...

atamanroman Over a year ago

@spyro I guess you could check if ids.size() == 1?

|

Idcmp · Accepted Answer · 2015-09-18 02:07:18Z

55

You should do something like this:

Call:

GET http://localhost:8080/public/test/1,2,3,4

Your controller:

@RequestMapping(value="/test/{firstNameIds}", method=RequestMethod.GET)
@ResponseBody
public String test(@PathVariable List<Integer> firstNameIds) {
     //Example: pring your params
     for(Integer param : firstNameIds) {
        System.out.println("id: " + param);
     }
     return "Dummy";
}

edited Sep 18, 2015 at 2:07

Idcmp

6911 gold badge9 silver badges20 bronze badges

answered Oct 30, 2014 at 11:51

Bruno Conrado Santos

5504 silver badges4 bronze badges

5 Comments

Idcmp Over a year ago

Confirmed the above works with Spring 4.2, likely with most of Spring 4.x. This is also the most Java-like answer offered.

Priyal Over a year ago

Does Jersey support this pattern?

Sushil Over a year ago

got 400 error code, this small change worked for me. public String test(@PathVariable("firstNameIds") List<Integer> firstNameIds) {

Sachin HR Over a year ago

I am sending data as ["first","second"].Can you tell how to accept it at controller using PathVariable?

Onic Team Over a year ago

@SachinHR : List<String>

Jaime · Accepted Answer · 2014-10-27 04:34:50Z

12

if you want to use Square brackets - []

DELETE http://localhost:8080/public/test/[1,2,3,4]

@RequestMapping(value="/test/[{firstNameIds}]", method=RequestMethod.DELETE)
@ResponseBody
public String test(@PathVariable String[] firstNameIds)
{
    // firstNameIds: [1,2,3,4]
    return "Dummy"; 
}

(Tested with Spring MVC 4.1.1)

answered Oct 27, 2014 at 4:34

Jaime

2,3781 gold badge17 silver badges21 bronze badges

1 Comment

Schenz Over a year ago

This works great when wrapping in square brackets, but what if I'm required to send a list wrapped in curly braces? that always seems to blow-up on me...

dardo · Accepted Answer · 2012-03-08 21:54:45Z

3

Could do @PathVariable String ids, then parse the string.

So something like:

@RequestMapping(value="/test/{firstNameIds}", method=RequestMethod.GET)
@ResponseBody
public String test(@PathVariable String firstNameIds)
{
     String[] ids = firstNameIds.split(",");
     return "Dummy"; 
}

You'd pass in:

http://localhost:8080/public/test/1,3,4,50

answered Mar 8, 2012 at 21:54

dardo

4,9805 gold badges38 silver badges53 bronze badges

Comments

aminography · Accepted Answer · 2020-05-10 05:33:35Z

0

At first, put this in your code (Add @PathVariable) :

@GetMapping(path="/test/{firstNameIds}",produces = {"application/json"})
public String test(@PathVariable List<String> firstNameIds)
{
     return "Dummy"; 
}

You'd pass in: http://localhost:8080/public/test/Agent,xxx,yyyy

edited May 10, 2020 at 5:33

aminography

22.9k14 gold badges79 silver badges80 bronze badges

answered May 10, 2020 at 3:37

Abdellah Abair

11 bronze badge

Collectives™ on Stack Overflow

Passing an Array or List to @Pathvariable - Spring/Java

5 Answers 5

6 Comments

5 Comments

1 Comment

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

6 Comments

5 Comments

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related