halkhalil / dropwizard-swagger

Dropwizard Swagger 2.x and OpenAPI 3.x Integration

Dropwizard Swagger Integration

A Dropwizard bundle that serves Swagger UI static content and loads Swagger endpoints.

Current version has been tested with Dropwizard 2.0.28 and Swagger 2.1.13 which supports OpenApi 3.0 specifications

Requirements

• Dropwizard 4.0.2
• Swagger API 2.1.16
• Swagger UI 4.6.2

Usage

• Add the Maven dependency (available in Maven Central)

<dependency>
    <groupId>in.vectorpro.dropwizard</groupId>
    <artifactId>dropwizard-swagger</artifactId>
    <version>2.0.28-2</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 @OpenAPIDefinition annotated resources>

• In your Application class:

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

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