io.federecio.dropwizard.swagger.SwaggerBundle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dropwizard-swagger Show documentation
A simple way to document your REST APIs in DropWizard using Swagger
There is a newer version: 4.0.5-1
// Copyright (C) 2014 Federico Recio
/**
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.federecio.dropwizard.swagger;

import io.dropwizard.Configuration;
import io.dropwizard.ConfiguredBundle;
import io.dropwizard.assets.AssetsBundle;
import io.dropwizard.setup.Bootstrap;
import io.dropwizard.setup.Environment;
import io.dropwizard.views.ViewBundle;
import io.swagger.config.FilterFactory;
import io.swagger.converter.ModelConverters;
import io.swagger.jackson.ModelResolver;
import io.swagger.jaxrs.listing.ApiListingResource;
import io.swagger.jaxrs.listing.SwaggerSerializers;

/**
 * A {@link io.dropwizard.ConfiguredBundle} that provides hassle-free
 * configuration of Swagger and Swagger UI on top of Dropwizard.
 */
public abstract class SwaggerBundle
        implements ConfiguredBundle {

    @Override
    public void initialize(Bootstrap bootstrap) {
        bootstrap.addBundle(new ViewBundle());
        ModelConverters.getInstance()
                .addConverter(new ModelResolver(bootstrap.getObjectMapper()));
    }

    @Override
    public void run(T configuration, Environment environment) throws Exception {
        final SwaggerBundleConfiguration swaggerBundleConfiguration = getSwaggerBundleConfiguration(
                configuration);
        if (swaggerBundleConfiguration == null) {
            throw new IllegalStateException(
                    "You need to provide an instance of SwaggerBundleConfiguration");
        }

        if (!swaggerBundleConfiguration.isEnabled()) {
            return;
        }

        final ConfigurationHelper configurationHelper = new ConfigurationHelper(
                configuration, swaggerBundleConfiguration);
        new AssetsBundle("/swagger-static",
                configurationHelper.getSwaggerUriPath(), null, "swagger-assets")
                        .run(environment);

        new AssetsBundle("/swagger-static/oauth2-redirect.html",
                configurationHelper.getOAuth2RedirectUriPath(), null, "swagger-oauth2-connect")
                        .run(environment);

        swaggerBundleConfiguration.build(configurationHelper.getUrlPattern());

        FilterFactory.setFilter(new AuthParamFilter());

        environment.jersey().register(new ApiListingResource());
        environment.jersey().register(new SwaggerSerializers());
        if (swaggerBundleConfiguration.isIncludeSwaggerResource()) {
            environment.jersey()
                    .register(new SwaggerResource(
                            configurationHelper.getUrlPattern(),
                            swaggerBundleConfiguration
                                    .getSwaggerViewConfiguration(),
                            swaggerBundleConfiguration.getSwaggerOAuth2Configuration(),
                            swaggerBundleConfiguration.getContextRoot()));
        }
    }

    protected abstract SwaggerBundleConfiguration getSwaggerBundleConfiguration(
            T configuration);
}