com.ofg.infrastructure.web.swagger.SwaggerConfiguration.java Source code

Introduction

Here is the source code for com.ofg.infrastructure.web.swagger.SwaggerConfiguration.java

Source

package com.ofg.infrastructure.web.swagger;

import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
import com.mangofactory.swagger.models.dto.ApiInfo;
import com.mangofactory.swagger.plugin.EnableSwagger;
import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

/**
 * Adds configuration enabling Swagger in Spring via {@link SwaggerSpringMvcPlugin}
 */
@Configuration
@ComponentScan("com.mangofactory.swagger")
@EnableSwagger
public class SwaggerConfiguration extends WebMvcConfigurerAdapter {

    @Bean
    public SwaggerSpringMvcPlugin swaggerSpringMvcPlugin(@Value("${rest.api.version:1.0}") String apiVersion,
            SpringSwaggerConfig springSwaggerConfig, ApiInfo apiInfo,
            @Value("${rest.api.urls.to.list:.*}") String urlsToList) {
        return new SwaggerSpringMvcPlugin(springSwaggerConfig).apiInfo(apiInfo).apiVersion(apiVersion)
                .includePatterns(urlsToList);
    }

    @Bean
    public ApiInfo apiInfo(@Value("${rest.api.title:Microservice API}") String title,
            @Value("${rest.api.description:APIs for this microservice}") String description,
            @Value("${rest.api.terms:Defined by 4finance internal licences}") String terms,
            @Value("${rest.api.contact:info@4finance.com}") String contact,
            @Value("${rest.api.license.type:4finance internal licence}") String licenseType,
            @Value("${rest.api.license.url:http://4finance.com}") String licenseUrl) {
        return new ApiInfo(title, description, terms, contact, licenseType, licenseUrl);
    }

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/swagger").setViewName("/swagger/index.html");
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/swagger/**", "/*.js", "/images/**", "/lib/**", "/css/**")
                .addResourceLocations("classpath:/static/swagger/", "classpath:/static/swagger/images/",
                        "classpath:/static/swagger/lib/", "classpath:/static/swagger/css/");
    }
}