Dropwizard Swagger support

A simple way to document your REST APIs in DropWizard using Swagger

License	Apache License, Version 2.0
Categories	DropWizard Container Microservices Swagger Program Interface REST Frameworks
GroupId	io.federecio
ArtifactId	dropwizard-swagger
Last Version	0.7.0
Release Date	Apr 27, 2015
Type	jar
Description	Dropwizard Swagger support A simple way to document your REST APIs in DropWizard using Swagger
Project URL	https://github.com/federecio/dropwizard-swagger/
Source Code Management	http://github.com/federecio/dropwizard-swagger

Download dropwizard-swagger

Filename	Size
dropwizard-swagger-0.7.0.pom
dropwizard-swagger-0.7.0.jar	149 KB
dropwizard-swagger-0.7.0-sources.jar	146 KB
dropwizard-swagger-0.7.0-javadoc.jar	49 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.federecio/dropwizard-swagger/ -->
<dependency>
    <groupId>io.federecio</groupId>
    <artifactId>dropwizard-swagger</artifactId>
    <version>0.7.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.federecio/dropwizard-swagger/
implementation 'io.federecio:dropwizard-swagger:0.7.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.federecio/dropwizard-swagger/
implementation ("io.federecio:dropwizard-swagger:0.7.0")

Apache Buildr

'io.federecio:dropwizard-swagger:jar:0.7.0'

Apache Ivy

<dependency org="io.federecio" name="dropwizard-swagger" rev="0.7.0">
  <artifact name="dropwizard-swagger" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.federecio', module='dropwizard-swagger', version='0.7.0')
)

Scala SBT

libraryDependencies += "io.federecio" % "dropwizard-swagger" % "0.7.0"

Leiningen

[io.federecio/dropwizard-swagger "0.7.0"]

Dependencies

compile (6)

Group / Artifact	Type	Version
io.dropwizard : dropwizard-core	jar	0.8.0
io.dropwizard : dropwizard-assets	jar	0.8.0
io.dropwizard : dropwizard-views	jar	0.8.0
io.dropwizard : dropwizard-views-freemarker	jar	0.8.0
com.wordnik : swagger-jersey2-jaxrs	jar	1.5.1-M2
xml-apis : xml-apis	jar	1.4.01

test (6)

Group / Artifact	Type	Version
junit : junit	jar	4.11
com.jayway.restassured : rest-assured	jar	1.7.2
io.federecio : dropwizard-junit	jar	0.6
org.seleniumhq.selenium.client-drivers : selenium-java-client-driver	jar	1.0.2
org.seleniumhq.selenium : selenium-java	jar	2.45.0
org.apache.httpcomponents : httpclient	jar	4.3.2

Project Modules

There are no modules declared in this project.

dropwizard-swagger

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

Current version has been tested with Dropwizard 0.8.0 and Swagger 1.5.1-M2 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.

License

http://www.apache.org/licenses/LICENSE-2.0

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.0  |   1.5.1-M2| v2.1.4-M1

How to use it

• Add the Maven dependency (available in Maven Central)

    <dependency>
        <groupId>io.federecio</groupId>
        <artifactId>dropwizard-swagger</artifactId>
        <version>0.7.0</version>
    </dependency>
  

• Add the following to your Configuration class:

    public class YourConfiguration extends Configuration {
    ...
        @JsonProperty("swagger")
        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
    swagger:
      resourcePackage: <a comma separated string of the packages that contain your @Api annotated resources>
  

• In your Application class:

    @Override
    public void initialize(Bootstrap<YourConfiguration> bootstrap) {
        ...
        bootstrap.addBundle(new SwaggerBundle<TestConfiguration>() {
            @Override
            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

Sample Application

Take a look at this sample application that shows how to integrate DropWizard and Swagger: dropwizard-swagger-sample-app

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.

Contributors

• Federico Recio @federecio
• Jochen Szostek [prefabsoft] (http://prefabsoft.com)
• Damien Raude-Morvan [drazzib] (https://github.com/drazzib)
• Marcel Stör [marcelstoer] (https://github.com/marcelstoer)
• Flemming Frandsen https://github.com/dren-dk
• Tristan Burch [tburch] (https://github.com/tburch)
• Matt Carrier [mattcarrier] (https://github.com/mattcarrier)

Versions

Version
0.7.0 Apr 27, 2015
0.6 Apr 8, 2015
0.5.3 Feb 20, 2015
0.5.2 Oct 10, 2014
0.5.1 Jul 20, 2014
0.5 Jul 18, 2014