Dropwizard + swagger example

[tony tam]

Thanks to @andreisavu, there is now a sample of native swagger integration with dropwizard here:

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

questions or feedback welcome!

[ryleyg]

I'm curious what opinions are out there on swagger annotations vs javadoc introspection.

i really like this:

https://github.com/ryankennedy/swagger-jaxrs-doclet

think it's clean and forces people to write javadoc (which they should be doing anyway), but i can see the value in a regimented structure.

?

ryley

[Ryan Kennedy]

Having written swagger-jaxrs-doclet, I'm of the opinion that nobody should use swagger's java/scala integration bits (extending their classes, using their annotations, etc). If you use JAX-RS then you've already fully annotated everything. You don't even have to write any JavaDocs to use the doclet, but if you do those comments are incorporated.

The extra bits of swagger classes in your inheritance chain are gross.

-- 

Ryan Kennedy

[tony tam]

Extending the wordnik classes is no longer needed, but the annotations still are.  So if you don't want to modify your source, the doclet is cool (thanks for contributing that project, Ryan).  Otherwise, try out the annotation-based approach, they may just fit your fancy.

Tony

[Jonathan Brownell]

I'm interested in experimenting with swagger-jaxrs-doclet vs. classic Swagger annotations in my Dropwizard Java service. But, I'm having a hard time finding any examples of Javadoc extensions supported by swagger-jaxrs-doclet. Is there any guide or example available?

As an example, I've run across an example JAX-RS doclet here:

http://fromage.github.io/jax-doclets/docs/0.10.0/html/index.html#d0e463

But these seem do not seem to be supported byswagger-jaxrs-doclet, although I do need the ability to specify things like its @returnWrapped.

Any guidance would be appreciated!

-JB

[Ryan Kennedy]

I think you talking about my swagger-jaxrs-doclet. If so, that doesn't use any JavaDoc extensions. Just JAX-RS annotations and regular-old JavaDoc comments.

Ryan

--
You received this message because you are subscribed to the Google Groups "dropwizard-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dropwizard-us...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

[Michael McCarthy]

Hi Ryan,

Is there a non-snapshot version of your project around?

Thanks,

Michael

[Ryan Kennedy]

Not yet. I could peel one off tonight and get it into maven central if that would be helpful. 

Ryan

[Michael McCarthy]

That would be great. I can code against the snapshot version but we'd need a tag should we decide to use it. I can get back to you when we've made the decision rather than waste your time now, unless you were planning one anyway.

[Jeremy McJunkin]

Ryan,

Thanks for this effort.  I'm new to both Dropwizard and java webservices in general.  I've found https://github.com/ryankennedy/swagger-jaxrs-doclet and added the plugin to my pom file and re-packaged, however, I'm not sure where to go from here?  Does this produce a service that I can use with: https://github.com/wordnik/swagger-ui#readme ?

[Matthew Flower]

I had the same problem sometime back.  I ended up updating the dropwizard-swagger project just enough to make it work for me.  My main complaints were:

1. It didn't actually work with dropwizard 0.6.2

2. Swagger-ui didn't really work unless you matched the settings the dropwizard-swagger project wanted.

If you'd like to try it, it's up at https://github.com/MattFlower/dropwizard-swagger.  If you find it useful, it might be worth putting some more time into it.

-m

[Jeremy McJunkin]

Thanks.  Is the readme valid?  I'm guessing that's for the original.  Is the work you've done in a maven repo?

[Jeremy McJunkin]

Nevermind, I see that it is, however, I think what's got me confused is that I used to add the SwaggerBundle in my existing service class.  This seems like I should have a separate service running for the swagger ui.  Ill give that a try.

[Jeremy McJunkin]

Ok, I see I just need to have my existing Configuration implement SwaggerUIConfigContainer, which I have done and returned my SwaggerUIConfig. However, when I start up my service, I just get an empty response from /api-docs.json

[Jeremy McJunkin]

Figured it out, we had removed auto-detection of getters because that's not the implementation we wanted in our response.  Once I enabled that, it all worked.

[Matthew Flower]

Happy that you were able to get it to work.  I've added a bit to the Readme about implementing the SwaggerUIConfigContainer.

-m

[Ryan Kennedy]

I made some changes a couple weeks back to swagger-jaxrs-doclet so you won't need a dropwizard bundle anymore (it became tedious to try supporting multiple versions of dropwizard, particularly when crossing the boundary where some of the Bundle-type interfaces were changing). In the new world, the doclet step generates static content (HTML and JSON) and deposits it into a location that ensures the HTML and the JSON ends up as a resource in your JAR file. At that point, you just need to wire up the dropwizard AssetsBundle to serve that content up. The sample application does this today:

https://github.com/ryankennedy/swagger-jaxrs-doclet/blob/master/jaxrs-doclet-sample-dropwizard/pom.xml

https://github.com/ryankennedy/swagger-jaxrs-doclet/blob/master/jaxrs-doclet-sample-dropwizard/src/main/java/com/hypnoticocelot/jaxrs/doclet/sample/SampleService.java#L22

Ryan

[Christophe Furmaniak]

I don't know if the following is related to the work of some of you, but there is now a sample usage of Swagger inside a Dropwizard project on the main swagger project pages, see https://github.com/wordnik/swagger-core/wiki/JavaDropwizard-Quickstart

[Christophe Furmaniak]

Ok, that was the first post message, I can go back to bed

[Gautam Priya]

Curious - does this wiki page still exist at this place or has it moved elsewhere - https://github.com/wordnik/swagger-core/wiki/JavaDropwizard-Quickstart 

[tony tam]

Hi, please take a look at the swagger-samples directory for dropwizard + swagger integration:

https://github.com/swagger-api/swagger-samples/tree/master/java/java-dropwizard

[jpl...@gmail.com]

I've also forked a popular dropwizard-swagger module to https://github.com/smoketurner/dropwizard-swagger as the previous version wasn't being maintained.

-Justin