From 26b87a77c527605d12c3c40b15f95de41e87f51e Mon Sep 17 00:00:00 2001 From: Lizi Date: Fri, 30 Mar 2018 09:32:21 +0000 Subject: Add swagger.json as discovery release artifacts Change-Id: I1c2d023dce35a4e74b7f2b0e91b8e3c0423b18da Issue-ID: MSB-187 Signed-off-by: Lizi --- sdclient/discovery-service/pom.xml | 78 +++++++++++++++++++++- .../src/main/resources/swagger.properties | 50 ++++++++++++++ 2 files changed, 127 insertions(+), 1 deletion(-) create mode 100644 sdclient/discovery-service/src/main/resources/swagger.properties diff --git a/sdclient/discovery-service/pom.xml b/sdclient/discovery-service/pom.xml index 982338d..a1b93ec 100644 --- a/sdclient/discovery-service/pom.xml +++ b/sdclient/discovery-service/pom.xml @@ -75,10 +75,86 @@ guava ${guava.version} - + + + 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}/target/classes + + + + + + compile + + generate + + + + + + org.codehaus.mojo + build-helper-maven-plugin + + + attach-artifacts + package + + attach-artifact + + + + + target/classes/swagger.json + json + schema + + + + + + org.apache.maven.plugins maven-jar-plugin diff --git a/sdclient/discovery-service/src/main/resources/swagger.properties b/sdclient/discovery-service/src/main/resources/swagger.properties new file mode 100644 index 0000000..22f31e3 --- /dev/null +++ b/sdclient/discovery-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. +# ONAP Service REST API version +api-version=1.0.0 + +# ONAP Service REST API swagger document title +api-title=MicroService Bus Discovery rest API + +# ONAP Service REST API swagger document description +api-description=MicroService Bus Discovery rest API + +# ONAP Service REST API supported protocols +api-schemas=http,https + +# ONAP 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.sdclient.resources + +# 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