eu.bcvsolutions.idm.core.api.config.swagger.AbstractSwaggerConfig.java Source code

Introduction

Here is the source code for eu.bcvsolutions.idm.core.api.config.swagger.AbstractSwaggerConfig.java

Source

package eu.bcvsolutions.idm.core.api.config.swagger;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

import org.springframework.data.domain.Pageable;
import org.springframework.http.ResponseEntity;
import org.springframework.util.Assert;
import org.springframework.util.MultiValueMap;

import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.Lists;

import eu.bcvsolutions.idm.core.api.domain.ModuleDescriptor;
import eu.bcvsolutions.idm.core.api.rest.BaseController;
import io.swagger.annotations.Api;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.BasicAuth;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * Modular swagger simple configuration
 * - expose all api endpoints in given basePackage
 *
 * @see #api(String)
 * @author Radek Tomika
 *
 */
public abstract class AbstractSwaggerConfig implements SwaggerConfig {

    /**
     * Module for this swagger configuration
     *
     * @return
     */
    protected abstract ModuleDescriptor getModuleDescriptor();

    /**
     * Docket initialization by module conventions.
     *
     * @see ModuleDescriptor
     * @param basePackage Expose endpoints from given base basePackages
     * @return
     */
    protected Docket api(String... basePackages) {
        return new Docket(DocumentationType.SWAGGER_2)
                // common
                .forCodeGeneration(true).genericModelSubstitutes(ResponseEntity.class)
                .securitySchemes(Arrays.asList(new BasicAuth(AUTHENTICATION_BASIC), apiKey()))
                .ignoredParameterTypes(Pageable.class, MultiValueMap.class)
                // module
                .groupName(getModuleDescriptor().getId()).select().apis(getApis(basePackages)).paths(getPaths())
                .build().apiInfo(metaData());
    }

    /**
     * Expose endpoints from given base packages. Security endpoint will be in all docs.
     *
     * @param basePackages
     * @return
     */
    protected Predicate<RequestHandler> getApis(String... basePackages) {
        Assert.notEmpty(basePackages);
        //
        List<Predicate<RequestHandler>> predicates = new ArrayList<>();
        // endpoints from packages
        predicates.add(Predicates.or(Arrays.asList(basePackages).stream().map(RequestHandlerSelectors::basePackage)
                .collect(Collectors.toList())));
        // and with annotations
        predicates.add(RequestHandlerSelectors.withClassAnnotation(Api.class));
        //
        return Predicates.and(predicates);
    }

    /**
     * Expose endpoints with given path only.
     *
     * @return
     */
    protected Predicate<String> getPaths() {
        return PathSelectors.ant(BaseController.BASE_PATH + "/**");
    }

    /**
     * CIDMST token authentication
     *
     * @return
     */
    protected ApiKey apiKey() {
        return new ApiKey(AUTHENTICATION_CIDMST, AUTHENTICATION_CIDMST_TOKEN, "header");
    }

    /**
     * TODO: license to properties (maven license plugin or simple pom props?)
     *
     * @return
     */
    protected ApiInfo metaData() {
        ApiInfo apiInfo = new ApiInfo(getModuleDescriptor().getName() + " - RESTful API",
                getModuleDescriptor().getDescription(), getModuleDescriptor().getVersion(), "Terms of service",
                new Contact(getModuleDescriptor().getVendor(), getModuleDescriptor().getVendorUrl(),
                        getModuleDescriptor().getVendorEmail()),
                "MIT", "https://github.com/bcvsolutions/CzechIdMng/blob/develop/LICENSE", Lists.newArrayList());
        return apiInfo;
    }
}