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

Go to download
// 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 javax.annotation.Nullable;
import org.hibernate.validator.constraints.NotEmpty;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Strings;
import io.swagger.jaxrs.config.BeanConfig;
import io.swagger.models.Contact;

/**
 * For the meaning of all these properties please refer to Swagger documentation
 * or {@link io.swagger.jaxrs.config.BeanConfig}
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class SwaggerBundleConfiguration {

    /**
     * This is the only property that is required for Swagger to work correctly.
     * 
     * It is a comma separated list of the all the packages that contain the
     * {@link io.swagger.annotations.Api} annotated resources
     */
    @NotEmpty
    private String resourcePackage = "";

    @Nullable
    private String title;

    @Nullable
    private String version;

    @Nullable
    private String description;

    @Nullable
    private String termsOfServiceUrl;

    @Nullable
    private String contact;

    @Nullable
    private String contactEmail;

    @Nullable
    private String contactUrl;

    @Nullable
    private String license;

    @Nullable
    private String licenseUrl;

    private SwaggerViewConfiguration swaggerViewConfiguration = new SwaggerViewConfiguration();
    private SwaggerOAuth2Configuration swaggerOAuth2Configuration = new SwaggerOAuth2Configuration();
    private boolean prettyPrint = true;

    @Nullable
    private String host;

    private String contextRoot = "/";
    private String[] schemes = new String[] { "http" };
    private boolean enabled = true;
    private boolean includeSwaggerResource = true;

    /**
     * For most of the scenarios this property is not needed.
     * 
     * This is not a property for Swagger but for bundle to set up Swagger UI
     * correctly. It only needs to be used of the root path or the context path
     * is set programmatically and therefore cannot be derived correctly. The
     * problem arises in that if you set the root path or context path in the
     * run() method in your Application subclass the bundle has already been
     * initialized by that time and so does not know you set the path
     * programmatically.
     */
    @Nullable
    private String uriPrefix;

    @JsonProperty
    public String getResourcePackage() {
        return resourcePackage;
    }

    @JsonProperty
    public void setResourcePackage(String resourcePackage) {
        this.resourcePackage = resourcePackage;
    }

    @Nullable
    @JsonProperty
    public String getTitle() {
        return title;
    }

    @JsonProperty
    public void setTitle(@Nullable String title) {
        this.title = title;
    }

    @Nullable
    @JsonProperty
    public String getVersion() {
        return version;
    }

    @JsonProperty
    public void setVersion(@Nullable String version) {
        this.version = version;
    }

    @Nullable
    @JsonProperty
    public String getDescription() {
        return description;
    }

    @JsonProperty
    public void setDescription(@Nullable String description) {
        this.description = description;
    }

    @Nullable
    @JsonProperty
    public String getTermsOfServiceUrl() {
        return termsOfServiceUrl;
    }

    @JsonProperty
    public void setTermsOfServiceUrl(@Nullable String termsOfServiceUrl) {
        this.termsOfServiceUrl = termsOfServiceUrl;
    }

    @Nullable
    @JsonProperty
    public String getContact() {
        return contact;
    }

    @JsonProperty
    public void setContact(@Nullable String contact) {
        this.contact = contact;
    }

    @Nullable
    @JsonProperty
    public String getContactEmail() {
        return contactEmail;
    }

    @JsonProperty
    public void setContactEmail(@Nullable String contactEmail) {
        this.contactEmail = contactEmail;
    }

    @Nullable
    @JsonProperty
    public String getContactUrl() {
        return contactUrl;
    }

    @JsonProperty
    public void setContactUrl(@Nullable String contactUrl) {
        this.contactUrl = contactUrl;
    }

    @Nullable
    @JsonProperty
    public String getLicense() {
        return license;
    }

    @JsonProperty
    public void setLicense(@Nullable String license) {
        this.license = license;
    }

    @Nullable
    @JsonProperty
    public String getLicenseUrl() {
        return licenseUrl;
    }

    @JsonProperty
    public void setLicenseUrl(@Nullable String licenseUrl) {
        this.licenseUrl = licenseUrl;
    }

    @Nullable
    @JsonProperty
    public String getUriPrefix() {
        return uriPrefix;
    }

    @JsonProperty
    public void setUriPrefix(@Nullable String uriPrefix) {
        this.uriPrefix = uriPrefix;
    }

    @JsonProperty
    public SwaggerViewConfiguration getSwaggerViewConfiguration() {
        return swaggerViewConfiguration;
    }

    @JsonProperty
    public void setSwaggerViewConfiguration(
            final SwaggerViewConfiguration swaggerViewConfiguration) {
        this.swaggerViewConfiguration = swaggerViewConfiguration;
    }

    @JsonProperty
    public SwaggerOAuth2Configuration getSwaggerOAuth2Configuration() {
        return swaggerOAuth2Configuration;
    }

    @JsonProperty("oauth2")
    public void setSwaggerOAuth2Configuration(
            final SwaggerOAuth2Configuration swaggerOAuth2Configuration) {
        this.swaggerOAuth2Configuration = swaggerOAuth2Configuration;
    }

    @JsonProperty
    public boolean isPrettyPrint() {
        return prettyPrint;
    }

    @JsonProperty
    public void setIsPrettyPrint(final boolean isPrettyPrint) {
        this.prettyPrint = isPrettyPrint;
    }

    @Nullable
    @JsonProperty
    public String getHost() {
        return host;
    }

    @JsonProperty
    public void setHost(@Nullable String host) {
        this.host = host;
    }

    @JsonProperty
    public String getContextRoot() {
        return contextRoot;
    }

    @JsonProperty
    public void setContextRoot(String contextRoot) {
        this.contextRoot = contextRoot;
    }

    @JsonProperty
    public String[] getSchemes() {
        return schemes;
    }

    @JsonProperty
    public void setSchemes(String[] schemes) {
        this.schemes = schemes;
    }

    @JsonProperty
    public boolean isEnabled() {
        return enabled;
    }

    @JsonProperty
    public void setIsEnabled(final boolean isEnabled) {
        this.enabled = isEnabled;
    }

    @JsonProperty
    public boolean isIncludeSwaggerResource() {
        return includeSwaggerResource;
    }

    @JsonProperty
    public void setIncludeSwaggerResource(final boolean include) {
        this.includeSwaggerResource = include;
    }

    @JsonIgnore
    public BeanConfig build(String urlPattern) {
        if (Strings.isNullOrEmpty(resourcePackage)) {
            throw new IllegalStateException(
                    "Resource package needs to be specified"
                            + " for Swagger to correctly detect annotated resources");
        }

        final BeanConfig config = new BeanConfig();
        config.setTitle(title);
        config.setVersion(version);
        config.setDescription(description);
        config.setContact(contact);
        config.setLicense(license);
        config.setLicenseUrl(licenseUrl);
        config.setTermsOfServiceUrl(termsOfServiceUrl);
        config.setPrettyPrint(prettyPrint);
        config.setBasePath(
                ("/".equals(contextRoot) ? "" : contextRoot) + urlPattern);
        config.setResourcePackage(resourcePackage);
        config.setSchemes(schemes);
        config.setHost(host);
        config.setScan(true);

        // Assign contact email/url after scan, since BeanConfig.scan will
        // create a new info.Contact instance, thus overriding any info.Contact
        // settings prior to scan.
        if (contactEmail != null || contactUrl != null) {
            if (config.getInfo().getContact() == null) {
                config.getInfo().setContact(new Contact());
            }
            if (contactEmail != null) {
                config.getInfo().getContact().setEmail(contactEmail);
            }
            if (contactUrl != null) {
                config.getInfo().getContact().setUrl(contactUrl);
            }
        }

        return config;
    }
}