Reorganize dashboard into subfolders

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

diff --git a/dashboard/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/config/SwaggerConfiguration.java b/dashboard/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/config/SwaggerConfiguration.java
new file mode 100644 (file)
index 0000000..b4bb0a3
--- /dev/null
+++ b/dashboard/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/config/SwaggerConfiguration.java
@@ -0,0 +1,68 @@
+/*-
+ * ========================LICENSE_START=================================
+ * O-RAN-SC
+ * %%
+ * Copyright (C) 2019 AT&T Intellectual Property
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================LICENSE_END===================================
+ */
+
+package org.oransc.ric.portal.dashboard.config;
+
+import org.oransc.ric.portal.dashboard.DashboardApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.service.Contact;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+/**
+ * http://www.baeldung.com/swagger-2-documentation-for-spring-rest-api
+ */
+@Configuration
+@EnableSwagger2
+public class SwaggerConfiguration {
+
+       /**
+        * @return new Docket
+        */
+       @Bean
+       public Docket api() {
+               return new Docket(DocumentationType.SWAGGER_2).select() //
+                               .apis(RequestHandlerSelectors.basePackage(DashboardApplication.class.getPackage().getName())) //
+                               .paths(PathSelectors.any()) //
+                               .build() //
+                               .apiInfo(apiInfo());
+       }
+
+       private ApiInfo apiInfo() {
+               final String version = DashboardApplication.class.getPackage().getImplementationVersion();
+               return new ApiInfoBuilder() //
+                               .title("RIC Dashboard backend") //
+                               .description("Proxies access to RIC services.")//
+                               .termsOfServiceUrl("Terms of service") //
+                               .contact(new Contact("RIC Dashboard Dev Team", //
+                                               "http://no-docs-yet.org/", //
+                                               "noreply@O-RAN-SC.org")) //
+                               .license("Apache 2.0 License").licenseUrl("http://www.apache.org/licenses/LICENSE-2.0") //
+                               .version(version == null ? "version not available" : version) //
+                               .build();
+       }
+}