a Dropwizard bundle that serves Swagger UI static content and loads Swagger endpoints.
JavaScript Java Other
Pull request Compare This branch is 169 commits ahead of federecio:master.
Latest commit a54a760 Jan 11, 2017 @jplock jplock committed on GitHub Update README.md



Build Status Coverage Status Maven Central GitHub license

A Dropwizard bundle that serves Swagger UI static content and loads Swagger endpoints. Swagger UI static content is taken from https://github.com/swagger-api/swagger-ui

Current version has been tested with Dropwizard 1.0.5 and Swagger 1.5.12 which supports Swagger 2 spec!

Note: if you come from previous versions there have been some changes in the way the bundle is configured, see details below.



Version matrix

dropwizard-swagger Dropwizard Swagger API Swagger UI
< 0.5 0.7.x 1.3.2 ?
0.5.x 0.7.x 1.3.12 v2.1.4-M1
0.6.x 0.8.0 1.3.12 v2.1.4-M1
0.7.x 0.8.x 1.5.1-M2 v2.1.4-M1
0.7.2 0.8.4 1.5.3 v2.1.2
0.9.x 0.9.x 1.5.9 v2.1.5
1.0.x 1.0.x 1.5.12 v2.2.10

How to use it

  • Add the Maven dependency (available in Maven Central)
  • Add the following to your Configuration class:
public class YourConfiguration extends Configuration {

    public SwaggerBundleConfiguration swaggerBundleConfiguration;
  • Add the following your configuration yaml (this is the minimal configuration you need):
prop1: value1
prop2: value2

# the only required property is resourcePackage, for more config options see below
  resourcePackage: <a comma separated string of the packages that contain your @Api annotated resources>
  • In your Application class:
public void initialize(Bootstrap<YourConfiguration> bootstrap) {
    bootstrap.addBundle(new SwaggerBundle<YourConfiguration>() {
        protected SwaggerBundleConfiguration getSwaggerBundleConfiguration(YourConfiguration configuration) {
            return configuration.swaggerBundleConfiguration;
  • As usual, add Swagger annotations to your resource classes and methods

  • Open a browser and hit http://localhost:<your_port>/swagger

Additional Swagger configuration

To see all the properties that can be used to customize Swagger see SwaggerBundleConfiguration.java

A note on Swagger 2

Host and port do not seem to be needed for Swagger 2 to work properly as it uses relative URLs. At the moment I haven't run through all the scenarios so some adjustments might be needed, please open a bug if you encounter any problems.