From 86683c58addadfeabe12d10c2fa26cfead22c2fe Mon Sep 17 00:00:00 2001 From: Wojciech Sliwka Date: Tue, 9 Apr 2019 14:57:02 +0200 Subject: [PATCH] Support for swagger API definitions available under /vid/v2/api-docs Change-Id: Ie7e63bfbdb8d41c43bc04ca13351dba533776a8a Issue-ID: VID-377 Signed-off-by: Wojciech Sliwka --- vid-app-common/pom.xml | 5 +++++ .../src/main/java/org/onap/vid/controller/WebConfig.java | 15 +++++++++++++++ .../vid/controller/{ => open}/HealthCheckController.java | 3 ++- .../vid/controller/{ => open}/MaintenanceController.java | 2 +- .../controller/{ => open}/RoleGeneratorController.java | 2 +- .../onap/vid/controller/{ => open}/VersionController.java | 2 +- .../controller/{ => open}/HealthCheckControllerTest.java | 3 ++- .../controller/{ => open}/MaintenanceControllerTest.java | 3 ++- .../{ => open}/RoleGeneratorControllerTest.java | 3 ++- .../vid/controller/{ => open}/VersionControllerTest.java | 3 ++- 10 files changed, 33 insertions(+), 8 deletions(-) rename vid-app-common/src/main/java/org/onap/vid/controller/{ => open}/HealthCheckController.java (98%) rename vid-app-common/src/main/java/org/onap/vid/controller/{ => open}/MaintenanceController.java (99%) rename vid-app-common/src/main/java/org/onap/vid/controller/{ => open}/RoleGeneratorController.java (98%) rename vid-app-common/src/main/java/org/onap/vid/controller/{ => open}/VersionController.java (98%) rename vid-app-common/src/test/java/org/onap/vid/controller/{ => open}/HealthCheckControllerTest.java (98%) rename vid-app-common/src/test/java/org/onap/vid/controller/{ => open}/MaintenanceControllerTest.java (99%) rename vid-app-common/src/test/java/org/onap/vid/controller/{ => open}/RoleGeneratorControllerTest.java (96%) rename vid-app-common/src/test/java/org/onap/vid/controller/{ => open}/VersionControllerTest.java (95%) diff --git a/vid-app-common/pom.xml b/vid-app-common/pom.xml index 205d6422a..0cc2195e9 100755 --- a/vid-app-common/pom.xml +++ b/vid-app-common/pom.xml @@ -818,5 +818,10 @@ com.google.guava guava + + io.springfox + springfox-swagger2 + 2.9.2 + diff --git a/vid-app-common/src/main/java/org/onap/vid/controller/WebConfig.java b/vid-app-common/src/main/java/org/onap/vid/controller/WebConfig.java index 543aa9432..e00c2d7a5 100644 --- a/vid-app-common/src/main/java/org/onap/vid/controller/WebConfig.java +++ b/vid-app-common/src/main/java/org/onap/vid/controller/WebConfig.java @@ -42,11 +42,18 @@ import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.togglz.core.manager.FeatureManager; +import springfox.documentation.builders.PathSelectors; +import springfox.documentation.builders.RequestHandlerSelectors; +import springfox.documentation.spi.DocumentationType; +import springfox.documentation.spring.web.plugins.Docket; +import springfox.documentation.swagger2.annotations.EnableSwagger2; + import javax.servlet.ServletContext; import java.io.File; import java.io.IOException; +@EnableSwagger2 @Configuration public class WebConfig { @@ -193,4 +200,12 @@ public class WebConfig { } + @Bean + public Docket api(){ + return new Docket(DocumentationType.SWAGGER_2) + .select() + .apis(RequestHandlerSelectors.basePackage("org.onap.vid.controller.open")) + .paths(PathSelectors.any()) + .build(); + } } diff --git a/vid-app-common/src/main/java/org/onap/vid/controller/HealthCheckController.java b/vid-app-common/src/main/java/org/onap/vid/controller/open/HealthCheckController.java similarity index 98% rename from vid-app-common/src/main/java/org/onap/vid/controller/HealthCheckController.java rename to vid-app-common/src/main/java/org/onap/vid/controller/open/HealthCheckController.java index 04d5babcc..92e1a1802 100644 --- a/vid-app-common/src/main/java/org/onap/vid/controller/HealthCheckController.java +++ b/vid-app-common/src/main/java/org/onap/vid/controller/open/HealthCheckController.java @@ -18,11 +18,12 @@ * ============LICENSE_END========================================================= */ -package org.onap.vid.controller; +package org.onap.vid.controller.open; import org.onap.portalsdk.core.controller.UnRestrictedBaseController; import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate; import org.onap.portalsdk.core.util.SystemProperties; +import org.onap.vid.controller.HealthStatus; import org.onap.vid.dao.FnAppDoaImpl; import org.onap.vid.model.GitRepositoryState; import org.springframework.beans.factory.annotation.Autowired; diff --git a/vid-app-common/src/main/java/org/onap/vid/controller/MaintenanceController.java b/vid-app-common/src/main/java/org/onap/vid/controller/open/MaintenanceController.java similarity index 99% rename from vid-app-common/src/main/java/org/onap/vid/controller/MaintenanceController.java rename to vid-app-common/src/main/java/org/onap/vid/controller/open/MaintenanceController.java index dfba4e31a..d1004401a 100644 --- a/vid-app-common/src/main/java/org/onap/vid/controller/MaintenanceController.java +++ b/vid-app-common/src/main/java/org/onap/vid/controller/open/MaintenanceController.java @@ -1,4 +1,4 @@ -package org.onap.vid.controller; +package org.onap.vid.controller.open; /*- * ============LICENSE_START======================================================= diff --git a/vid-app-common/src/main/java/org/onap/vid/controller/RoleGeneratorController.java b/vid-app-common/src/main/java/org/onap/vid/controller/open/RoleGeneratorController.java similarity index 98% rename from vid-app-common/src/main/java/org/onap/vid/controller/RoleGeneratorController.java rename to vid-app-common/src/main/java/org/onap/vid/controller/open/RoleGeneratorController.java index 107142d7f..7b57df2c7 100644 --- a/vid-app-common/src/main/java/org/onap/vid/controller/RoleGeneratorController.java +++ b/vid-app-common/src/main/java/org/onap/vid/controller/open/RoleGeneratorController.java @@ -19,7 +19,7 @@ * ============LICENSE_END========================================================= */ -package org.onap.vid.controller; +package org.onap.vid.controller.open; import static org.springframework.http.HttpStatus.OK; diff --git a/vid-app-common/src/main/java/org/onap/vid/controller/VersionController.java b/vid-app-common/src/main/java/org/onap/vid/controller/open/VersionController.java similarity index 98% rename from vid-app-common/src/main/java/org/onap/vid/controller/VersionController.java rename to vid-app-common/src/main/java/org/onap/vid/controller/open/VersionController.java index aa15f0fa3..0a4d6f5ac 100644 --- a/vid-app-common/src/main/java/org/onap/vid/controller/VersionController.java +++ b/vid-app-common/src/main/java/org/onap/vid/controller/open/VersionController.java @@ -18,7 +18,7 @@ * ============LICENSE_END========================================================= */ -package org.onap.vid.controller; +package org.onap.vid.controller.open; import com.fasterxml.jackson.core.type.TypeReference; diff --git a/vid-app-common/src/test/java/org/onap/vid/controller/HealthCheckControllerTest.java b/vid-app-common/src/test/java/org/onap/vid/controller/open/HealthCheckControllerTest.java similarity index 98% rename from vid-app-common/src/test/java/org/onap/vid/controller/HealthCheckControllerTest.java rename to vid-app-common/src/test/java/org/onap/vid/controller/open/HealthCheckControllerTest.java index 49e6645bc..76ee5617b 100644 --- a/vid-app-common/src/test/java/org/onap/vid/controller/HealthCheckControllerTest.java +++ b/vid-app-common/src/test/java/org/onap/vid/controller/open/HealthCheckControllerTest.java @@ -18,7 +18,7 @@ * ============LICENSE_END========================================================= */ -package org.onap.vid.controller; +package org.onap.vid.controller.open; import org.apache.log4j.BasicConfigurator; import org.junit.Before; @@ -26,6 +26,7 @@ import org.junit.Test; import org.junit.runner.RunWith; import org.mockito.Mock; import org.mockito.junit.MockitoJUnitRunner; +import org.onap.vid.controller.open.HealthCheckController; import org.onap.vid.dao.FnAppDoaImpl; import org.springframework.http.MediaType; import org.springframework.test.web.servlet.MockMvc; diff --git a/vid-app-common/src/test/java/org/onap/vid/controller/MaintenanceControllerTest.java b/vid-app-common/src/test/java/org/onap/vid/controller/open/MaintenanceControllerTest.java similarity index 99% rename from vid-app-common/src/test/java/org/onap/vid/controller/MaintenanceControllerTest.java rename to vid-app-common/src/test/java/org/onap/vid/controller/open/MaintenanceControllerTest.java index b9193810a..3e78828f0 100644 --- a/vid-app-common/src/test/java/org/onap/vid/controller/MaintenanceControllerTest.java +++ b/vid-app-common/src/test/java/org/onap/vid/controller/open/MaintenanceControllerTest.java @@ -1,4 +1,4 @@ -package org.onap.vid.controller; +package org.onap.vid.controller.open; /*- * ============LICENSE_START======================================================= @@ -35,6 +35,7 @@ import org.onap.vid.category.AddCategoryOptionResponse; import org.onap.vid.category.AddCategoryOptionsRequest; import org.onap.vid.category.CategoryParameterOptionRep; import org.onap.vid.category.CategoryParametersResponse; +import org.onap.vid.controller.open.MaintenanceController; import org.onap.vid.model.CategoryParameter; import org.onap.vid.model.CategoryParameterOption; import org.onap.vid.services.CategoryParameterService; diff --git a/vid-app-common/src/test/java/org/onap/vid/controller/RoleGeneratorControllerTest.java b/vid-app-common/src/test/java/org/onap/vid/controller/open/RoleGeneratorControllerTest.java similarity index 96% rename from vid-app-common/src/test/java/org/onap/vid/controller/RoleGeneratorControllerTest.java rename to vid-app-common/src/test/java/org/onap/vid/controller/open/RoleGeneratorControllerTest.java index c5b4a55dc..c1509d956 100644 --- a/vid-app-common/src/test/java/org/onap/vid/controller/RoleGeneratorControllerTest.java +++ b/vid-app-common/src/test/java/org/onap/vid/controller/open/RoleGeneratorControllerTest.java @@ -19,7 +19,7 @@ * ============LICENSE_END========================================================= */ -package org.onap.vid.controller; +package org.onap.vid.controller.open; import static org.mockito.BDDMockito.given; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; @@ -32,6 +32,7 @@ import org.junit.Test; import org.junit.runner.RunWith; import org.mockito.Mock; import org.mockito.runners.MockitoJUnitRunner; +import org.onap.vid.controller.open.RoleGeneratorController; import org.onap.vid.services.RoleGeneratorService; import org.springframework.http.MediaType; import org.springframework.test.web.servlet.MockMvc; diff --git a/vid-app-common/src/test/java/org/onap/vid/controller/VersionControllerTest.java b/vid-app-common/src/test/java/org/onap/vid/controller/open/VersionControllerTest.java similarity index 95% rename from vid-app-common/src/test/java/org/onap/vid/controller/VersionControllerTest.java rename to vid-app-common/src/test/java/org/onap/vid/controller/open/VersionControllerTest.java index f92a26ea7..835ea4a66 100644 --- a/vid-app-common/src/test/java/org/onap/vid/controller/VersionControllerTest.java +++ b/vid-app-common/src/test/java/org/onap/vid/controller/open/VersionControllerTest.java @@ -18,8 +18,9 @@ * ============LICENSE_END========================================================= */ -package org.onap.vid.controller; +package org.onap.vid.controller.open; +import org.onap.vid.controller.open.VersionController; import org.testng.annotations.DataProvider; import org.testng.annotations.Test; -- 2.16.6