From ff8d695d686c7f8f9dba746f8c7ee2233f46fddb Mon Sep 17 00:00:00 2001 From: Kanagaraj Manickam k00365106 Date: Thu, 21 Sep 2017 12:56:39 +0530 Subject: Add sample swagger.json for msb MSB-78 Change-Id: I0be949bb24d4ecc3a8fc55c808f848ecb8f74171 Signed-off-by: Kanagaraj Manickam k00365106 --- example/pom.xml | 130 ++++++++++++++++++++------ example/src/main/resources/swagger.json | 14 +++ example/src/main/resources/swagger.properties | 50 ++++++++++ 3 files changed, 165 insertions(+), 29 deletions(-) create mode 100644 example/src/main/resources/swagger.json create mode 100644 example/src/main/resources/swagger.properties diff --git a/example/pom.xml b/example/pom.xml index 1432950..01dace2 100644 --- a/example/pom.xml +++ b/example/pom.xml @@ -1,40 +1,112 @@ - 4.0.0 + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + 4.0.0 org.onap.oparent oparent 1.0.0-SNAPSHOT - - org.onap.msb.java-sdk - msb-java-sdk-example - msb-java-sdk-example - 1.0.0-SNAPSHOT - jar - + org.onap.msb.java-sdk + msb-java-sdk-example + msb-java-sdk-example + 1.0.0-SNAPSHOT + jar + + org.onap.msb.java-sdk - msb-java-sdk - 1.0.0-SNAPSHOT - - - io.dropwizard - dropwizard-core - 0.8.0 - - - - - - maven-compiler-plugin - - 1.8 - 1.8 - - - - + msb-java-sdk + 1.0.0-SNAPSHOT + + + io.dropwizard + dropwizard-core + 0.8.0 + + + + + + maven-compiler-plugin + + 1.8 + 1.8 + + + + + 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/example/src/main/resources/swagger.json b/example/src/main/resources/swagger.json new file mode 100644 index 0000000..cd66074 --- /dev/null +++ b/example/src/main/resources/swagger.json @@ -0,0 +1,14 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "MicroService Bus rest API Sample", + "version" : "1.0.0", + "title" : "MicroService Bus rest API Sample", + "license" : { + "name" : "https://wiki.onap.org/display/DW/Apache+2.0+License" + } + }, + "host" : "127.0.0.1:80", + "basePath" : "/api/microservices/v1", + "schemes" : [ "http", "https" ] +} \ No newline at end of file diff --git a/example/src/main/resources/swagger.properties b/example/src/main/resources/swagger.properties new file mode 100644 index 0000000..41eb5f0 --- /dev/null +++ b/example/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 Sample + +# Open-O Service REST API swagger document description +api-description=MicroService Bus rest API Sample + +# 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.sdk.example.server + +# 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