main/src/main/java/org/onap/policy/api/main/config/SwaggerConfig.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 Bell Canada. 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  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.api.main.config;
  22
  23 import org.springframework.context.annotation.Bean;
  24 import org.springframework.context.annotation.Configuration;
  25 import springfox.documentation.builders.PathSelectors;
  26 import springfox.documentation.builders.RequestHandlerSelectors;
  27 import springfox.documentation.spi.DocumentationType;
  28 import springfox.documentation.spring.web.plugins.Docket;
  29 import springfox.documentation.swagger2.annotations.EnableSwagger2;
  30
  31 @Configuration
  32 @EnableSwagger2
  33 public class SwaggerConfig {
  34
  35     /**
  36      * Create a bean of type Docket to determine the swagger configuration.
  37      * @return docket bean with swagger configuration.
  38      */
  39     @Bean
  40     public Docket api() {
  41         return new Docket(DocumentationType.SWAGGER_2)
  42             .select()
  43             .apis(RequestHandlerSelectors.basePackage("org.onap.policy.api.main.rest"))
  44             .paths(PathSelectors.any())
  45             .build();
  46     }
  47 }