gerrit.onap Code Review - dcaegen2/services.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * BBS-RELOCATION-CPE-AUTHENTICATION-HANDLER
   4  * ================================================================================
   5  * Copyright (C) 2019-2020 NOKIA Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.bbs.event.processor.config;
  22
  23 import org.springframework.context.annotation.Bean;
  24 import org.springframework.context.annotation.Configuration;
  25 import org.springframework.context.annotation.Profile;
  26 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
  27 import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
  28
  29 import springfox.documentation.builders.ApiInfoBuilder;
  30 import springfox.documentation.builders.PathSelectors;
  31 import springfox.documentation.builders.RequestHandlerSelectors;
  32 import springfox.documentation.service.ApiInfo;
  33 import springfox.documentation.spi.DocumentationType;
  34 import springfox.documentation.spring.web.plugins.Docket;
  35 import springfox.documentation.swagger2.annotations.EnableSwagger2;
  36
  37 @Configuration
  38 @Profile("production")
  39 public class SwaggerConfiguration extends WebMvcConfigurationSupport {
  40
  41     private static final String PACKAGE_PATH = "org.onap.bbs.event.processor";
  42     private static final String API_TITLE = "BBS Event Processor";
  43     private static final String DESCRIPTION = "This page lists bbs-event-processor REST API details";
  44     private static final String VERSION = "1.0";
  45     private static final String RESOURCES_PATH = "classpath:/META-INF/resources/";
  46     private static final String WEBJARS_PATH = RESOURCES_PATH + "webjars/";
  47     private static final String SWAGGER_UI = "swagger-ui.html";
  48     private static final String WEBJARS = "/webjars/**";
  49
  50     /**
  51      * Swagger configuration function for hosting it next to spring http website.
  52      *
  53      * @return Docket
  54      */
  55     @Bean
  56     public Docket api() {
  57         return new Docket(DocumentationType.SWAGGER_2)
  58                 .apiInfo(apiInfo())
  59                 .select()
  60                 .apis(RequestHandlerSelectors.basePackage(PACKAGE_PATH))
  61                 .paths(PathSelectors.any())
  62                 .build();
  63     }
  64
  65     private ApiInfo apiInfo() {
  66         return new ApiInfoBuilder()
  67                 .title(API_TITLE)
  68                 .description(DESCRIPTION)
  69                 .version(VERSION)
  70                 .build();
  71     }
  72
  73
  74     @Override
  75     protected void addResourceHandlers(ResourceHandlerRegistry registry) {
  76         registry.addResourceHandler(SWAGGER_UI)
  77                 .addResourceLocations(RESOURCES_PATH);
  78
  79         registry.addResourceHandler(WEBJARS)
  80                 .addResourceLocations(WEBJARS_PATH);
  81     }
  82 }