aboutsummaryrefslogtreecommitdiffstats
path: root/vnfmarket-be/vnf-sdk-marketplace/src
diff options
context:
space:
mode:
authorMurali-P <murali.p@huawei.com>2018-04-25 11:23:07 +0530
committerMurali-P <murali.p@huawei.com>2018-04-25 11:55:01 +0530
commite9ff86cbd26db4a699a17d7d60727334e219b6d0 (patch)
treef1426c055855e65ddfa96b6638d67596fc52c024 /vnfmarket-be/vnf-sdk-marketplace/src
parent5ef837efbf16ed70e38cdeb75a8761e0c5f42326 (diff)
Enable swagger documentation for API
Swagger UI and Swagger docs Issue-ID: VNFSDK-157 Change-Id: I9aeda5c364741c975a8d0d8b788a22c9d3f5f39f Signed-off-by: Murali-P <murali.p@huawei.com>
Diffstat (limited to 'vnfmarket-be/vnf-sdk-marketplace/src')
-rw-r--r--vnfmarket-be/vnf-sdk-marketplace/src/main/webapp/WEB-INF/web.xml23
-rw-r--r--vnfmarket-be/vnf-sdk-marketplace/src/main/webapp/apidocs/index.html61
2 files changed, 81 insertions, 3 deletions
diff --git a/vnfmarket-be/vnf-sdk-marketplace/src/main/webapp/WEB-INF/web.xml b/vnfmarket-be/vnf-sdk-marketplace/src/main/webapp/WEB-INF/web.xml
index 8dc5575c..cf229269 100644
--- a/vnfmarket-be/vnf-sdk-marketplace/src/main/webapp/WEB-INF/web.xml
+++ b/vnfmarket-be/vnf-sdk-marketplace/src/main/webapp/WEB-INF/web.xml
@@ -9,17 +9,34 @@
<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
<init-param>
<param-name>jersey.config.server.provider.packages</param-name>
- <param-value>org.onap.vnfsdk.marketplace.resource</param-value>
+ <param-value>io.swagger.jaxrs.listing,
+ org.onap.vnfsdk.marketplace.resource
+ </param-value>
</init-param>
<init-param>
<param-name>jersey.config.server.provider.classnames</param-name>
<param-value>org.glassfish.jersey.media.multipart.MultiPartFeature</param-value>
- </init-param>
+ </init-param>
+ <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>Jersey RESTful Application</servlet-name>
<url-pattern>/onapapi/vnfsdk-marketplace/v1/*</url-pattern>
- </servlet-mapping>
+ </servlet-mapping>
+
+ <servlet>
+ <servlet-name>Jersey2Config</servlet-name>
+ <servlet-class>io.swagger.jersey.config.JerseyJaxrsConfig</servlet-class>
+ <init-param>
+ <param-name>api.version</param-name>
+ <param-value>1.0.0</param-value>
+ </init-param>
+ <init-param>
+ <param-name>swagger.api.basepath</param-name>
+ <param-value>http://localhost:8702//onapapi/vnfsdk-marketplace/v1</param-value>
+ </init-param>
+ <load-on-startup>2</load-on-startup>
+ </servlet>
<filter>
<filter-name>CorsFilter</filter-name>
diff --git a/vnfmarket-be/vnf-sdk-marketplace/src/main/webapp/apidocs/index.html b/vnfmarket-be/vnf-sdk-marketplace/src/main/webapp/apidocs/index.html
new file mode 100644
index 00000000..47f9c8ac
--- /dev/null
+++ b/vnfmarket-be/vnf-sdk-marketplace/src/main/webapp/apidocs/index.html
@@ -0,0 +1,61 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="UTF-8">
+ <title>Swagger UI</title>
+ <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
+ <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
+ <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
+ <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+ <style>
+ html
+ {
+ box-sizing: border-box;
+ overflow: -moz-scrollbars-vertical;
+ overflow-y: scroll;
+ }
+
+ *,
+ *:before,
+ *:after
+ {
+ box-sizing: inherit;
+ }
+
+ body
+ {
+ margin:0;
+ background: #fafafa;
+ }
+ </style>
+ </head>
+
+ <body>
+ <div id="swagger-ui"></div>
+
+ <script src="./swagger-ui-bundle.js"> </script>
+ <script src="./swagger-ui-standalone-preset.js"> </script>
+ <script>
+ window.onload = function() {
+
+ // Build a system
+ const ui = SwaggerUIBundle({
+ url: "http://localhost:8702/onapapi/vnfsdk-marketplace/v1/swagger.json",
+ dom_id: '#swagger-ui',
+ deepLinking: true,
+ presets: [
+ SwaggerUIBundle.presets.apis,
+ SwaggerUIStandalonePreset
+ ],
+ plugins: [
+ SwaggerUIBundle.plugins.DownloadUrl
+ ],
+ layout: "StandaloneLayout"
+ })
+
+ window.ui = ui
+ }
+ </script>
+ </body>
+</html>