2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 AT&T Intellectual Property and Nokia
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
21 package org.oransc.ric.portal.dashboard.config;
23 import org.oransc.ric.portal.dashboard.DashboardApplication;
24 import org.springframework.context.annotation.Bean;
25 import org.springframework.context.annotation.Configuration;
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;
37 * http://www.baeldung.com/swagger-2-documentation-for-spring-rest-api
41 public class SwaggerConfiguration {
48 return new Docket(DocumentationType.SWAGGER_2).select() //
49 .apis(RequestHandlerSelectors.basePackage(DashboardApplication.class.getPackage().getName())) //
50 .paths(PathSelectors.any()) //
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) //