webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/config/SwaggerConfiguration.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 AT&T Intellectual Property
   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.oransc.ric.portal.dashboard.config;
  22
  23 import org.oransc.ric.portal.dashboard.DashboardApplication;
  24 import org.springframework.context.annotation.Bean;
  25 import org.springframework.context.annotation.Configuration;
  26
  27 import springfox.documentation.builders.ApiInfoBuilder;
  28 import springfox.documentation.builders.PathSelectors;
  29 import springfox.documentation.builders.RequestHandlerSelectors;
  30 import springfox.documentation.service.ApiInfo;
  31 import springfox.documentation.service.Contact;
  32 import springfox.documentation.spi.DocumentationType;
  33 import springfox.documentation.spring.web.plugins.Docket;
  34 import springfox.documentation.swagger2.annotations.EnableSwagger2;
  35
  36 /**
  37  * http://www.baeldung.com/swagger-2-documentation-for-spring-rest-api
  38  */
  39 @Configuration
  40 @EnableSwagger2
  41 public class SwaggerConfiguration {
  42
  43         /**
  44          * @return new Docket
  45          */
  46         @Bean
  47         public Docket api() {
  48                 return new Docket(DocumentationType.SWAGGER_2).select() //
  49                                 .apis(RequestHandlerSelectors.basePackage(DashboardApplication.class.getPackage().getName())) //
  50                                 .paths(PathSelectors.any()) //
  51                                 .build() //
  52                                 .apiInfo(apiInfo());
  53         }
  54
  55         private ApiInfo apiInfo() {
  56                 final String version = DashboardApplication.class.getPackage().getImplementationVersion();
  57                 return new ApiInfoBuilder() //
  58                                 .title("RIC Dashboard backend") //
  59                                 .description("Proxies access to RIC services.")//
  60                                 .termsOfServiceUrl("Terms of service") //
  61                                 .contact(new Contact("RIC Dashboard Dev Team", //
  62                                                 "http://no-docs-yet.org/", //
  63                                                 "noreply@O-RAN-SC.org")) //
  64                                 .license("Apache 2.0 License").licenseUrl("http://www.apache.org/licenses/LICENSE-2.0") //
  65                                 .version(version == null ? "version not available" : version) //
  66                                 .build();
  67         }
  68 }