Optional @PathParam in Jax-RS

Question

I have a service where the last part of the path is optional, the user can both enter /mypath/ and /mypath/param1/.

I tried to use a regular expression to filter the last part of the path:

@Path("/mypath{param1: (/param1)?}")

I'm using RestEasy as my JAX-RS provider and the code works as expected in Tomcat but when I deploy it in JBoss I get a 405 return code when I do not submit the optional part.

Am I doing something wrong here or it's not possible to accomplish this in a portable way?

[**See Also**](http://stackoverflow.com/q/32765804/2587435) – Paul Samsotha Sep 25 '15 at 10:24 — Paul Samsotha, Sep 25 '15 at 10:24

score 47 · Accepted Answer · edited Dec 18 '15 at 08:30

47

The problem was the lack of whitespace before the colon:

@Path("/mypath{param1: (/param1)?}")

should be:

@Path("/mypath{param1 : (/param1)?}")

Apparently it's a bug, because the specification makes the whitespace around the colon optional. I also found that I'm not the first bitten by this bug.

edited Dec 18 '15 at 08:30

ROMANIA_engineer

54,432
29
203
199

answered Mar 29 '11 at 11:36

Fábio

3,291
5
36
49

3

Not working in my case but [this](http://stackoverflow.com/a/32778643/3143670) does – Neeraj Jain Oct 08 '15 at 13:18
1

@NeerajJain my question involves RestEasy, the one you linked is about Jersey. – Fábio Apr 22 '19 at 13:38
The value of `param1` includes the slash (`/`). Without manually cutting the slash in the code, is there a way to not include the slash in the value? – AlikElzin-kilaka May 12 '22 at 01:43

aruizca · Answer 2 · 2013-10-24T02:15:22.423

10

In my case I had to use this other expression:

@Path('/mypath/{param1 : (\\w+)?}')

Otherwise you have to clean the parameter.

edited Oct 24 '13 at 02:15

answered Oct 24 '13 at 02:09

aruizca

1,891
1
19
13

score 2 · Answer 3 · answered Mar 28 '11 at 15:01

2

Verify whether there is a path already defined with /mypath that accepts a different method, this could be the reason why you are getting 405 (Method not allowed) back. Also when you have optional parameters I guess it is better to make them query parameters.

answered Mar 28 '11 at 15:01

Prasanna

3,703
9
46
74

This was the error that I was getting. I had a `GET` at / and a `POST` at /{filename} where filename was optional. So the post at GET and POST were clashing. – QuirkyBit Feb 27 '21 at 01:56

score -11 · Answer 4 · answered Oct 05 '16 at 23:04

-11

With Dropwizard 1.0 and Java8 you can use Optional

@Path("/news")
getLastNews(@QueryParam("topicId") String topicId, @QueryParam("limit") Optional<Integer> limit)

It will give a response to both

/news?topicId=123213?limit=200

and

/news?topicId=123213

answered Oct 05 '16 at 23:04

Olesia

144
4

5

It is about `@Path` not `@QueryParam` – Zarathustra Jan 26 '17 at 18:24

Optional @PathParam in Jax-RS

4 Answers4

Linked

Related