#1 Add an URL parameter to configure the rendering for web sockets

Author: vincent-zurczak

ISSUE_TEMPLATE.md

@@ -54,7 +54,7 @@ function _dist() {
         './src/generated/templates.js',
         './node_modules/swagger-client/browser/swagger-client.js'
     ])
-    .pipe(order(['scripts.js', 'templates.js']))
+    .pipe(order(['**/javascript/**/*.js', '**/generated/templates.js']))
     .pipe(concat('swagger-ui.js'))
     .pipe(wrap('(function(){<%= contents %>}).call(this);'))
     .pipe(header(banner, { pkg: pkg }))

gulpfile.js

@@ -123,6 +123,16 @@ window.SwaggerUi = Backbone.Router.extend({
   render: function(){
     var authsModel;
     this.showMessage('Finished Loading Resource Information. Rendering Swagger UI...');
+    
+    // VZ: determine whether we display REST or web socket data
+    this.options.isRest = this.api.info.title.match(/\bREST\b/i) !== null;
+
+    // List all the operations for the web socket
+    if (! this.options.isRest) {
+      this.options.docExpansion = 'list';
+    }
+    // VZ
+    
     this.mainView = new SwaggerUi.Views.MainView({
       model: this.api,
       el: $('#' + this.dom_id),

src/main/javascript/SwaggerUi.js

@@ -10,11 +10,10 @@ $(function () {
   /*
    ** Only for tests! **
    ** Just copy your "swagger.json" file in the "dist" directory.
-
+   
   else {
-    url = 'swagger.json';
+    url = '/swagger.json';
   }
-  
   */
 
   // Check there is a valid URL

src/main/javascript/init.js

@@ -20,10 +20,14 @@ SwaggerUi.Views.OperationView = Backbone.View.extend({
     this.parentId = this.model.parentId;
     this.nickname = this.model.nickname;
     this.model.encodedParentId = encodeURIComponent(this.parentId);
+    this.model.isRest = false;
 
     if (opts.swaggerOptions) {
-      this.model.defaultRendering = opts.swaggerOptions.defaultModelRendering;
+      // VZ: determine whether we display REST or web socket data
+      this.model.isRest = opts.swaggerOptions.isRest;
+      // VZ
 
+      this.model.defaultRendering = opts.swaggerOptions.defaultModelRendering;
       if (opts.swaggerOptions.showRequestHeaders) {
         this.model.showRequestHeaders = true;
       }
@@ -83,14 +87,14 @@ SwaggerUi.Views.OperationView = Backbone.View.extend({
   },
 
   // Note: copied from CoffeeScript compiled file
-  // TODO: redactor
+  // TODO: refactor
   render: function() {
     var a, auth, auths, code, contentTypeModel, isMethodSubmissionSupported, k, key, l, len, len1, len2, len3, len4, m, modelAuths, n, o, p, param, q, ref, ref1, ref2, ref3, ref4, ref5, responseContentTypeView, responseSignatureView, schema, schemaObj, scopeIndex, signatureModel, statusCode, successResponse, type, v, value, produces, isXML, isJSON;
     isMethodSubmissionSupported = jQuery.inArray(this.model.method, this.model.supportedSubmitMethods()) >= 0;
     if (!isMethodSubmissionSupported) {
       this.model.isReadOnly = true;
     }
-     
+
     this.model.description = this.model.description || this.model.notes;
     this.model.oauth = null;
     modelAuths = this.model.authorizations || this.model.security;

src/main/javascript/view/OperationView.js

@@ -1,5 +1,5 @@
 <div class='info' id='api_info'>
-  <div class="info_title">Swagger UI for Roboconf's REST API</div>
+  <div class="info_title">Swagger UI for Roboconf :: {{info.title}}</div>
 </div>
 <div class='container' id='resources_container'>
   <div class='authorize-wrapper'></div>

src/main/template/main.handlebars

@@ -112,6 +112,7 @@
           </table>
           {{/if}}
         </form>
+        {{#if isRest}}
         <div class='response'>
           <h4 class='curl'>Curl</h4>
           <div class='block curl-content' style='display:none'></div>
@@ -125,8 +126,8 @@
           <div class='block show-curl-content'>
           	<input class='submit' type='submit' value='Show the CURL command'/>
           </div>
-          
         </div>
+        {{/if}}
       </div>
     </li>
   </ul>