dcae-analytics/dcae-analytics-tca-web/src/main/java/org/onap/dcae/analytics/tca/web/config/SwaggerConfig.java

   1 /*
   2  * ================================================================================
   3  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  * ============LICENSE_END=========================================================
  17  *
  18  */
  19
  20 package org.onap.dcae.analytics.tca.web.config;
  21
  22 import static org.onap.dcae.analytics.model.TcaModelConstants.TCA_REST_API_PREFIX;
  23
  24 import springfox.documentation.builders.ApiInfoBuilder;
  25 import springfox.documentation.builders.PathSelectors;
  26 import springfox.documentation.builders.RequestHandlerSelectors;
  27 import springfox.documentation.service.ApiInfo;
  28 import springfox.documentation.spi.DocumentationType;
  29 import springfox.documentation.spring.web.plugins.Docket;
  30 import springfox.documentation.swagger2.annotations.EnableSwagger2;
  31
  32 import org.springframework.context.annotation.Bean;
  33 import org.springframework.context.annotation.Configuration;
  34
  35 /**
  36  * @author Rajiv Singla
  37  */
  38 @Configuration
  39 @EnableSwagger2
  40 public class SwaggerConfig {
  41
  42     @Bean
  43     public Docket apiDocker() {
  44         return new Docket(DocumentationType.SWAGGER_2)
  45                 .apiInfo(getApiInfo())
  46                 .useDefaultResponseMessages(false)
  47                 .select()
  48                 .apis(RequestHandlerSelectors.basePackage("org.onap.dcae.analytics.tca.web.controller"))
  49                 .paths(PathSelectors.ant(TCA_REST_API_PREFIX + "**"))
  50                 .build();
  51     }
  52
  53
  54     private static ApiInfo getApiInfo() {
  55         return new ApiInfoBuilder()
  56                 .title("TCA (Threshold Crossing Alert) Analytics RESTful API")
  57                 .description("RESTful API for Threshold Crossing Alerts Analytics")
  58                 .license("Apache License Version 2.0")
  59                 .version("3.0")
  60                 .build();
  61     }
  62
  63 }