[Resolved] REST JAX-RS template parameters

Hi,

Thanks for reporting this. I need to investigate this a bit further, so I'll mark the thread as open.

Regards,
Arian
SmartBear Sweden

For whatever it's worth: we are using swagger https://developers.helloreverb.com/swagger/ to generate our services. This exact same problem was filed and fixed in swagger.

Hi again!

Sorry, but I'm not familiar with this kind of template parameter syntax

{issueId:[0-9]+}

Could you provide us with a reference to how it used?

Also, what kind of error do you get in SoapUI?

Please provide the contents of the soapUI log and error log tabs in the bottom of the main SoapUI window.

Finally if you've submitted a bug report regarding this to Swagger, it would be value for us if you could share it as well.

--
Regards

Erik
SmartBear Sweden

Another user appears to have hit the same issue: viewtopic.php?t=21127

This is starting to get outside my area of expertise.
We have two resources: one is at "/{gameCode}/issues/current", and the other is at "/{gameCode}/issues/{issueId:[0-9]+}". The way the backend distinguishes between two URLs, is that the second allows only numbers (the stuff after the colon is a regex).

SoapUI does not throw any kind of an error when making the call. It simply cannot find the parameter, regardless if I call it "issueId:[0-9]+" or "issueId".

One of our developers is working with the Swagger guys, and he fixed it right in the code. I do not know the ticket number, and the developer is currently on vacation. I will try to track this down for you.

Thanks! I think it will be useful if we can see the ticket.

Also at the same time, I would consider having this kind of validation on the client side more as a feature request than a bug.

Regards,
Shadid
SmartBear Sweden

I'm not sure I agree. This is standardized (as much as nay other standard) way of specifying REST parameters, and SoapUI currently does not support it.
But as long as it gets fixed ...

Hi again!

We would like to help you with this, but need some information on how to proceed here.
I can't really see the relation between this issue and http://www.soapui.org/forum/viewtopic.php?t=21127,
it doesn't seem like they are using your required format of template parameters

{issueId:[0-9]+}

, but rather a standard template parameter

{template}

.

Also, as Shadid mention, your required format seems to be used for server side validation of incoming request to the REST API.
Have you heard anything more from the Swagger team? I'm afraid we can't proceed if we don't get some more information on this.

--
Regards

Erik
SmartBear Sweden

Hi.

SmartBear Support wrote:
Also, as Shadid mention, your required format seems to be used for server side validation of incoming request to the REST API.

You are correct! This is a feature that is used primarily on the server to have two resources assigned to the same one URL!. So you are able to have URL like http://server.test/{param} and if I need the server to be able to handle numbers with one method and anything else with another method, in the WADL I will have two resources. One will have a URL like http://server.test/{param} to handle the "anything else", and the second will have a URL like http://server.test/{param:[0-9]+} to handle numbers only - the stuff after the colon is obviously a regex.

When SoapUI parses such a WADL it correctly generates the two methods and correctly extracts both URLs. The problem is that the second (numbers only) method has a resource parameter named as only "param" and it does not know what to do with the values that I specify - they never get substituted correctly. Worse: even if I correct the parameter name to match the extracted URL: "param:[0-9]+", SoapUI is still not able to make the connection.

There is no problem with Swagger, and there is nothing that I am expecting to hear from them. They made a fix to the framework (I do not know the bug number) and they are able to handle to above case correctly.

Hi again!

So we've looked it to this a bit more and looking at your WADL snippet we've found that the param name "issueId"

<param name="issueId" style="template" type="xs:int"/>

and the template parameter in the resource path "issueId:[0-9]+" doesn't match, which makes us believe that your WADL is broken.

How did you get this WADL? Is it generated from the server side code or did you create it manually?
If you created it manually, you should change the name of the resource path so it corresponds to the parameter name like this:

from

<resource path="/{gameCode}/issues/{issueId:[0-9]+}">

to

<resource path="/{gameCode}/issues/{issueId}">

If the WADL is generated by a tool, I believe this is an bug that should be reported.

--
Regards

Erik
SmartBear Sweden