Errors when implementing swagger in GRails with JAX-RS

[Scott Ryan]

I have some services that are implemented in jax-rs within grails and i am having some challenges getting swagger to work properly.  My services are defined as follows:

@Path('/api/1.0.0/event')
@Api(value = "/api/1.0.0/event", description = "Operations about Event")
@Consumes(['application/json'])
@Produces(['application/json'])

My Jersey path is

/api
/api/**

I have defined the swagger config as:

'swagger.api.basepath':'http://localhost:8080/amp/api/1.0.0','api.version':"1.0"

I access the service via the url   http://localhost:8080/amp/api/1.0.0/event

I do not use the .json ending to my service names

When i deploy I initially get an error that

SEVERE: Producing media type conflict.

And this occurs on my GET method.  If I comment out the GET method the error goes away.   

I also cannot access the resources.json at any combination of the URLS

So my questions are:

1. How to I access my service with out the .json extension and still get Swagger to work
2. How do I deal with my media type conflict error
3. Where do I go to in order to access the resources.json file

If I comment out my GET method and use the .json ending to my service url I get some valid documentation.


Here are the versions I am using

runtime ("com.wordnik:swagger-jaxrs_2.9.1:1.0.1"){
            excludes 'stax-api'
        }
        runtime "com.wordnik:swagger-core_2.9.1:1.0.1"



Thanks

Scott Ryan

[Scott Ryan]

I also tried using the technique where you use the listing file in a separate class and I get a ClassNotFound error getting the listing class

java.lang.ClassNotFoundException: class com.company.amp.resource.v100.EventResource not found
    at com.wordnik.swagger.core.SwaggerContext$.loadClass(SwaggerContext.scala:46)
    at com.wordnik.swagger.jaxrs.JavaHelp.getHelp(JavaHelp.scala:56)
    at com.sun.jersey.spi.container.JavaMethodInvokerFactory$1.invoke(JavaMethodInvokerFactory.java:60)

[tony tam]

Hi Scott, seems like there are some issues with how Grails is loading the classes, see here:

https://groups.google.com/forum/#!topic/swagger-swaggersocket/nTR2GSpDTfw

If you can help post a simple grails example (email is fine, too), I'd be happy to sort this out, along with the classloader issue.

[Scott Ryan]

I was able to make it work. I had to load the jars into the grails lib directory and that fixed the class loader issue.  Then I had to implement the API Listing class which I also did.  I am able t access both the resource listing and the individual service listing from the direct URL.  If I use the Swagger UI I am able to display the individual resource docs but not the resource listing.  Although the listing and the individual listing are downloaded they never display on the UI  There are no error so not sure how to debug.  Thanks for your help so far.

Scott Ryan

[Scott Ryan]

Here is an example that works. I am still having issues with one of my apps but 2 of the other ones work fine.  If you unzip this file and run it with grails run-war on then you can go to

http://localhost:8080/app/api/1.0.0/demo

http://localhost:8080/appname/doc/api.html you can see the swagger ui

The config of the jersey stuff is in the Config.groovy file and the servlet is configured to remove the .format from the URL's
Scott Ryan

[tony tam]

Hi Scott, just sent you an email--I think the groovy support is just about there, one issue that I expect to close tomorrow.

Tony

[Scott Ryan]

I think if you add

org.grails.jaxrs.url.mappings = ['/api','/api-docs']

it will route the /api-docs stuff correctly

Scott Ryan
President/CTO
Soaring Eagle L.L.C.
Highlands Ranch, Co. 80130
(303) 263-3044
sc...@theryansplace.com
www.soaringeagleco.com

[tony tam]

Got it--also, just added a sample app here:

https://github.com/wordnik/swagger-core/tree/master/samples/java-grails2

[Scott Ryan]

I am finally getting around to implementing this update and had one question. I still have GET s that return lists based on query parameters.  I assume that I still have to implement a separate listing file for each of my services to allow for such a structure?

The other fixes work perfectly.

Scott Ryan

[tony tam]

Hi Scott, can you explain more?