Query Parameters with enableUrlTemplating set to true

[safari137]

Fill details of my issue can be seen at : [http://stackoverflow.com/questions/39439214/swagger-param-documentation]

I have also read the closed issue at [https://github.com//issues/986]

My dilemma is that I need enableUrlTemplating set to true in order to have documentation on similar routes/maps that are only distinguished by certain query parameters (/students/{id}?age=20 and /students{id}?age=20&gender=male). I also can't stand seeing the swagger ui showing url/students{id}{?age}?age=20 and it obviously doesn't work either.

Is there any work around for presenting this correctly in the UI?

[dilipkrish]

Are you using this dependency io.springfox.ui:springfox-swagger-ui-rfc6570:0.9.7 for swagger-ui? Just released 0.9.7 but 0.9.6 should work too.

[safari137]

I thought I was, but apparently I'm not. What repository should I use for that? I'm using gradle.

[dilipkrish]

0.9.6 is available in both maven central and jcenter. However 0.9.7 is only available as of now on jcenter.

[safari137]

In any case I have 0.9.6 working,

However, now when I load localhost:8080/swagger-ui.html I see the navbar on the top with no data.
"Failed to load resource: the server responded with a status of 404 () http;//localhost:8080/configuration/ui" is in the console.

[dilipkrish]

😫 I just remembered, 0.9.6 will not work, you'll need to use 0.9.7. It takes a few hours to sync to maven central but if you include jcenter() as a repo in your gradle build you should find it.

[safari137]

Ahh okay. It doesn't seem to be available on jcenter for me just yet. 0.9.6 seems to be the last version.

https://jcenter.bintray.com/io/springfox/springfox-swagger-ui-rfc6570/

[dilipkrish]

Yeah there seems to be a hiccup. Switched the artifacts group id from io.springfox to io.springfox.ui. Will update this thread when that is fixed

[dilipkrish]

Ok it should be available now

[safari137]

That works great! Thank you very much.

[thomaszbz]

@dilipkrish I have the same issue with springfox versions 2.7.0 and 2.8.0: With enableUrlTemplating(true), swagger ui does not replace the RFC6570 template (e.g. it sends a GET request like https://example.com/api{?user_id%7D=&user_id=123 https://example.com/api{?user_id}&user_id=123) and therefore either receives 404 errors (with springfox-swagger-ui-rfc6570 enabled) or it lets tomcat fail (with springfox-swagger-ui-rfc6570 disabled).

Me too, my maven can only resolve 0.9.6 but not 0.9.7. Could you please publish 0.9.7 in common repos? It should be made available here:

https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui-rfc6570

[thomaszbz]

@dilipkrish It changed location and I found 0.9.7 and 1.0.0 here:

https://mvnrepository.com/artifact/io.springfox.ui/springfox-swagger-ui-rfc6570

[thomaszbz]

@dilipkrish With springfox version 2.7.0 or 2.8.0 and springfox-swagger-ui-rfc6570 version 1.0.0, it seems to work and swagger ui produces GET requests like:
https://example.com/api&user_id=1

But unfortunately, I had to disable the springfox-swagger-ui dependency which is tied to a springfox version. Would be great to de-incubate RFC6570 support so that the the ui version goes along with the springfox version.

[dilipkrish]

@thomaszbz you can use it with the latest springfox versions I believe 2.6+ atleast.

[sivashanthini]

@dilipkrish I am using springfox and swagger-ui of version 2.9.2. I needed the support of RFC6570 in the swagger-ui version 2.9.2. It would be great if RFC6570 support can be provided in swagger-ui 2.9.2 version also rather than in swagger-ui-rfc6570 1.0.0.

[membersound]

Is enableUrlTemplates still experimental, or could it be merged into master?