Configuring Swagger and Google Guice

Question

I am trying to add swagger to my project. Our setup is slightly different from sample projects. We use guice and guice-servlet for injection and run our JerseyServletModule.

Today our web.xml looks something like this.

<web-app ....> <listener> <listener-class>com.mypackage.MyServletModule</listener-class> </listener> <filter> <filter-name>guiceFilter</filter-name> <filter-class>com.google.inject.servlet.GuiceFilter</filter-class> </filter> <filter-mapping> <filter-name>guiceFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> </web-app> 

And the MyServletModule class looks like

 public class MyServletModule extends GuiceServletContextListener { ... @Override protected Injector getInjector() { JerseyServletModule api = new JerseyServletModule() { @Override protected void configureServlets() { ... bind().to() ... serve("/api/v1/*").with(GuiceContainer.class); } }; return Guice.createInjector(api); } } 

Where and how should swagger be added?

Answer 1

You need to tell Jersey where to find Swagger resources like this (where org.example is your package containing services):

 Map<String, String> params = Maps.newHashMap(); params.put(PackagesResourceConfig.PROPERTY_PACKAGES, "org.example;com.wordnik.swagger.jaxrs.listing"); serve("/api/v1/*").with(GuiceContainer.class, params); 

Also make sure Swagger is on your class path. If you are using Maven, add:

 <dependency> <groupId>com.wordnik</groupId> <artifactId>swagger-jaxrs_2.9.1</artifactId> <version>1.2.1</version> <scope>compile</scope> </dependency>