Add swagger UI
[vfc/nfvo/wfengine.git] / wfenginemgrservice / src / main / resources / api-doc / index.html
1 <!--\r
2 \r
3     Copyright 2016 ZTE Corporation.\r
4 \r
5     Licensed under the Apache License, Version 2.0 (the "License");\r
6     you may not use this file except in compliance with the License.\r
7     You may obtain a copy of the License at\r
8 \r
9         http://www.apache.org/licenses/LICENSE-2.0\r
10 \r
11     Unless required by applicable law or agreed to in writing, software\r
12     distributed under the License is distributed on an "AS IS" BASIS,\r
13     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
14     See the License for the specific language governing permissions and\r
15     limitations under the License.\r
16 \r
17 -->\r
18 <!DOCTYPE html>\r
19 <html>\r
20 <head>\r
21   <title>Swagger UI</title>\r
22   <link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/>\r
23   <link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/>\r
24   <link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>\r
25   <link href='css/reset.css' media='print' rel='stylesheet' type='text/css'/>\r
26   <link href='css/screen.css' media='print' rel='stylesheet' type='text/css'/>\r
27   <script type="text/javascript" src="lib/shred.bundle.js"></script>\r
28   <script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script>\r
29   <script src='lib/jquery.slideto.min.js' type='text/javascript'></script>\r
30   <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script>\r
31   <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script>\r
32   <script src='lib/handlebars-2.0.0.js' type='text/javascript'></script>\r
33   <script src='lib/underscore-min.js' type='text/javascript'></script>\r
34   <script src='lib/backbone-min.js' type='text/javascript'></script>\r
35   <script src='lib/swagger-client.js' type='text/javascript'></script>\r
36   <script src='swagger-ui.js' type='text/javascript'></script>\r
37   <script src='lib/highlight.7.3.pack.js' type='text/javascript'></script>\r
38   <script src='lib/marked.js' type='text/javascript'></script>\r
39 \r
40   <!-- enabling this will enable oauth2 implicit scope support -->\r
41   <script src='lib/swagger-oauth.js' type='text/javascript'></script>\r
42   <script type="text/javascript">\r
43     $(function () {\r
44       var url = window.location.search.match(/url=([^&]+)/);\r
45       if (url && url.length > 1) {\r
46         url = decodeURIComponent(url[1]);\r
47       } else {\r
48         url = "/api/workflow/v1/swagger.json";\r
49       }\r
50       window.swaggerUi = new SwaggerUi({\r
51         url: url,\r
52         dom_id: "swagger-ui-container",\r
53         supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],\r
54         onComplete: function(swaggerApi, swaggerUi){\r
55           if(typeof initOAuth == "function") {\r
56             /*\r
57             initOAuth({\r
58               clientId: "your-client-id",\r
59               realm: "your-realms",\r
60               appName: "your-app-name"\r
61             });\r
62             */\r
63           }\r
64           $('pre code').each(function(i, e) {\r
65             hljs.highlightBlock(e)\r
66           });\r
67         },\r
68         onFailure: function(data) {\r
69           log("Unable to Load SwaggerUI");\r
70         },\r
71         docExpansion: "none",\r
72         sorter : "alpha"\r
73       });\r
74 \r
75       function addApiKeyAuthorization() {\r
76         var key = $('#input_apiKey')[0].value;\r
77         log("key: " + key);\r
78         if(key && key.trim() != "") {\r
79             log("added key " + key);\r
80             window.authorizations.add("api_key", new ApiKeyAuthorization("api_key", key, "query"));\r
81         }\r
82       }\r
83 \r
84       $('#input_apiKey').change(function() {\r
85         addApiKeyAuthorization();\r
86       });\r
87 \r
88       // if you have an apiKey you would like to pre-populate on the page for demonstration purposes...\r
89       /*\r
90         var apiKey = "myApiKeyXXXX123456789";\r
91         $('#input_apiKey').val(apiKey);\r
92         addApiKeyAuthorization();\r
93       */\r
94 \r
95       window.swaggerUi.load();\r
96   });\r
97   </script>\r
98 </head>\r
99 \r
100 <body class="swagger-section">\r
101 <div id='header'>\r
102   <div class="swagger-ui-wrap">\r
103     <a id="logo" >Management Workflow Engine Service</a>\r
104     <form id='api_selector'>\r
105       <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>\r
106       <div class='input'><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div>\r
107       <div class='input'><a id="explore" href="#">Explore</a></div>\r
108     </form>\r
109   </div>\r
110 </div>\r
111 \r
112 <div id="message-bar" class="swagger-ui-wrap">&nbsp;</div>\r
113 <div id="swagger-ui-container" class="swagger-ui-wrap"></div>\r
114 </body>\r
115 </html>\r