From faa96aff9ec83d0690eff7088f8fa84654b2dfe5 Mon Sep 17 00:00:00 2001 From: Kanagaraj Manickam k00365106 Date: Wed, 20 Sep 2017 19:06:05 +0530 Subject: Add swagger-sdk support for MSB service It adds required changes to create the swagger.json at build time for MSB services. MSB-78 Change-Id: I84f37e01100f9b55ad231e419d6c3d3e42390a12 Signed-off-by: Kanagaraj Manickam k00365106 --- .../apiroute-service/dependency-reduced-pom.xml | 70 ++++++++++++++++ apiroute/apiroute-service/pom.xml | 95 ++++++++++++++++++++-- .../src/main/resources/swagger.properties | 50 ++++++++++++ 3 files changed, 207 insertions(+), 8 deletions(-) create mode 100644 apiroute/apiroute-service/src/main/resources/swagger.properties diff --git a/apiroute/apiroute-service/dependency-reduced-pom.xml b/apiroute/apiroute-service/dependency-reduced-pom.xml index 697e024..4c53010 100644 --- a/apiroute/apiroute-service/dependency-reduced-pom.xml +++ b/apiroute/apiroute-service/dependency-reduced-pom.xml @@ -67,6 +67,76 @@ + + org.codehaus.mojo + properties-maven-plugin + 1.0.0 + + + initialize + + read-project-properties + + + + ${basedir}/src/main/resources/swagger.properties + + + + + + + com.github.kongchen + swagger-maven-plugin + 3.1.4 + + + compile + + generate + + + + + + + ${api-rest-package} + http,https + ${api-host-ip}:${api-host-port} + ${api-base-path} + + ${api-title} + ${api-version} + ${api-description} + + ${api-license} + + + ${basedir}/src/main/resources + + + + + + maven-install-plugin + 2.3.1 + + + install-file-id + install + + install-file + + + ${basedir}/src/main/resources/swagger.json + ${project.groupId} + ${project.artifactId}-swagger-schema + ${project.version} + json + + + + diff --git a/apiroute/apiroute-service/pom.xml b/apiroute/apiroute-service/pom.xml index 9f047e9..3502768 100644 --- a/apiroute/apiroute-service/pom.xml +++ b/apiroute/apiroute-service/pom.xml @@ -1,11 +1,11 @@ - @@ -65,7 +65,7 @@ org.powermock powermock-api-mockito test - + com.orbitz.consul consul-client @@ -107,6 +107,12 @@ commons-io + + org.onap.msb.swagger-sdk + swagger-sdk + 1.0.0-SNAPSHOT + + @@ -158,6 +164,79 @@ + + + + org.codehaus.mojo + properties-maven-plugin + 1.0.0 + + + initialize + + read-project-properties + + + + ${basedir}/src/main/resources/swagger.properties + + + + + + + com.github.kongchen + swagger-maven-plugin + 3.1.4 + + + + ${api-rest-package} + http,https + ${api-host-ip}:${api-host-port} + ${api-base-path} + + ${api-title} + ${api-version} + ${api-description} + + ${api-license} + + + ${basedir}/src/main/resources + + + + + + compile + + generate + + + + + + org.apache.maven.plugins + maven-install-plugin + 2.3.1 + + + install-file-id + install + + install-file + + + ${basedir}/src/main/resources/swagger.json + ${project.groupId} + ${project.artifactId}-swagger-schema + ${project.version} + json + + + + diff --git a/apiroute/apiroute-service/src/main/resources/swagger.properties b/apiroute/apiroute-service/src/main/resources/swagger.properties new file mode 100644 index 0000000..af46762 --- /dev/null +++ b/apiroute/apiroute-service/src/main/resources/swagger.properties @@ -0,0 +1,50 @@ +# Copyright 2017 Huawei Technologies Co., Ltd. +# +# 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. + +# Used to do swagger configuration. +# Open-O Service REST API version +api-version=1.0.0 + +# Open-O Service REST API swagger document title +api-title=MicroService Bus rest API + +# Open-O Service REST API swagger document description +api-description=MicroService Bus rest API + +# Open-O Service REST API supported protocols +api-schemas=http,https + +# Open-O Service REST API ROOT URI +api-base-path=/api/microservices/v1 + +# swagger.json URI on top of api-base-path. so final URI would as follows +#//swagger.json +api-swagger-uri= + +# Set the root level java package path, where REST API implemented. +api-rest-package=org.onap.msb.apiroute + +# Enables swagger to scan the ROA defining the REST API +api-rest-package-scan=true + +# License details emebeded in generated swagger.json +api-license=https://wiki.onap.org/display/DW/Apache+2.0+License + +# if service-config-file-path does not have api-host-ip and api-host-port, +# then ip and port defined here will be used as default +api-host-ip=127.0.0.1 +api-host-port=80 + +# Set the below file path to service specific configuration file path +service-config-file-path= -- cgit 1.2.3-korg