GoDaddy Contributions

.gitignore

@@ -7,9 +7,12 @@ lib-cov
 *.pid
 *.gz
 
+.idea
 pids
 logs
 results
 
 npm-debug.log
 node_modules
+
+LoopBackExplorer.iml

lib/class-helper.js

@@ -23,7 +23,7 @@ var classHelper = module.exports = {
    */
   generateAPIDoc: function(aClass, opts) {
     return {
-      apiVersion: opts.version,
+      apiVersion: opts.version || '1',
       swaggerVersion: opts.swaggerVersion,
       basePath: opts.basePath,
       resourcePath: urlJoin('/', opts.resourcePath),
@@ -43,7 +43,7 @@ var classHelper = module.exports = {
   generateResourceDocAPIEntry: function(aClass) {
     return {
       path: aClass.http.path,
-      description: aClass.ctor.sharedCtor && aClass.ctor.sharedCtor.description
+      description: aClass.ctor.settings.description || aClass.ctor.sharedCtor && aClass.ctor.sharedCtor.description
     };
   }
 };

lib/model-helper.js

@@ -18,6 +18,18 @@ var modelHelper = module.exports = {
    * @return {Object} Associated model definition.
    */
   generateModelDefinition: function generateModelDefinition(modelClass, definitions) {
+    var processType = function(app, modelName, referencedModels) {
+      if (app && modelName) {
+        if (modelName.indexOf('[') == 0) {
+          modelName = modelName.replace(/[\[\]]/g, '');
+        }
+        var model = app.models[modelName];
+        if (model && referencedModels.indexOf(model) === -1) {
+          referencedModels.push(model);
+        }
+      }
+    }
+
     var def = modelClass.definition;
     var name = def.name;
     var out = definitions || {};
@@ -27,15 +39,15 @@ var modelHelper = module.exports = {
     }
     var required = [];
     // Don't modify original properties.
-    var properties = _cloneDeep(def.properties);
+    var properties = _cloneDeep(def.rawProperties || def.properties);
 
     var referencedModels = [];
     // Add models from settings
     if (def.settings && def.settings.models) {
       for (var m in def.settings.models) {
         var model = modelClass[m];
         if (typeof model === 'function' && model.modelName) {
-          if (referencedModels.indexOf(model) === -1) {
+          if (model && referencedModels.indexOf(model) === -1) {
             referencedModels.push(model);
           }
         }
@@ -58,6 +70,10 @@ var modelHelper = module.exports = {
 
       // Eke a type out of the constructors we were passed.
       prop = modelHelper.LDLPropToSwaggerDataType(prop);
+      processType(modelClass.app, prop.type, referencedModels);
+      if (prop.items) {
+        processType(modelClass.app, prop.items.type, referencedModels);
+      }
 
       // Required props sit in a per-model array.
       if (prop.required || (prop.id && !prop.generated)) {
@@ -95,15 +111,43 @@ var modelHelper = module.exports = {
     // Generate model definitions for related models
     for (var r in modelClass.relations) {
       var rel = modelClass.relations[r];
-      if (rel.modelTo){
-        generateModelDefinition(rel.modelTo, out);
+      if (rel.modelTo && referencedModels.indexOf(rel.modelTo) === -1) {
+        referencedModels.push(rel.modelTo);
+      }
+      if (rel.modelThrough && referencedModels.indexOf(rel.modelThrough) === -1) {
+        referencedModels.push(rel.modelThrough);
       }
-      if (rel.modelThrough) {
-        generateModelDefinition(rel.modelThrough, out);
+    }
+
+    if (modelClass.sharedClass) {
+      var remotes = modelClass.sharedClass.methods();
+      for (var remoteIdx in remotes) {
+        var remote = remotes[remoteIdx];
+        var accepts = remote.accepts;
+        if (accepts) {
+          for (var acceptIdx in accepts) {
+            processType(modelClass.app, accepts[acceptIdx].type, referencedModels);
+          }
+        }
+        var returns = remote.returns;
+        if (returns) {
+          for (var returnIdx in returns) {
+            processType(modelClass.app, returns[returnIdx].type, referencedModels);
+          }
+        }
+        var errors = remote.errors;
+        if (errors) {
+          for (var errorIdx in errors) {
+            processType(modelClass.app, errors[errorIdx].responseModel, referencedModels);
+          }
+        }
       }
     }
+
     for (var i = 0, n = referencedModels.length; i < n; i++) {
-      generateModelDefinition(referencedModels[i], out);
+      if (referencedModels[i].definition) {
+        generateModelDefinition(referencedModels[i], out);
+      }
     }
     return out;
   },
@@ -113,7 +157,7 @@ var modelHelper = module.exports = {
    * get a string type.
    * @param  {*} propType Prop type description.
    * @return {String}     Prop type string.
-   */ 
+   */
   getPropType: function getPropType(propType) {
     if (typeof propType === 'function') {
       // See https://github.com/strongloop/loopback-explorer/issues/32
@@ -126,7 +170,7 @@ var modelHelper = module.exports = {
   },
 
   isHiddenProperty: function(definition, propName) {
-    return definition.settings && 
+    return definition.settings &&
       Array.isArray(definition.settings.hidden) &&
       definition.settings.hidden.indexOf(propName) !== -1;
   },
@@ -135,6 +179,11 @@ var modelHelper = module.exports = {
   // Swagger spec.
   // https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#431-primitives
   LDLPropToSwaggerDataType: function LDLPropToSwaggerDataType(prop) {
+    if (typeof prop === 'string') {
+      prop = {
+        type: prop
+      }
+    }
     var out = _cloneDeep(prop);
     out.type = modelHelper.getPropType(out.type);
 

lib/route-helper.js

@@ -113,12 +113,71 @@ var routeHelper = module.exports = {
    * See https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#523-operation-object
    */
   routeToAPIDoc: function routeToAPIDoc(route, classDef) {
+    /**
+     * Converts from an sl-remoting data type to a Swagger dataType.
+     */
+    function prepareDataType(type) {
+      if (!type) {
+        return 'void';
+      }
+
+      if(Array.isArray(type)) {
+        if (type.length > 0) {
+          if (typeof type[0] === 'string') {
+            return '[' + type[0] + ']';
+          } else if (typeof type[0] === 'function') {
+            return '[' + type[0].name + ']';
+          } else if (typeof type[0] === 'object') {
+            if (typeof type[0].type === 'function') {
+              return '[' + type[0].type.name + ']';
+            } else {
+              return '[' + type[0].type + ']';
+            }
+          } else {
+            return '[' + type + ']';
+          }
+        }
+        return 'array';
+      }
+
+      // TODO(schoon) - Add support for complex dataTypes, "models", etc.
+      switch (type) {
+        case 'Array':
+          return 'array';
+        case 'Boolean':
+          return 'boolean';
+        case 'buffer':
+          return 'string';
+        case 'Date':
+          return 'date';
+        case 'number':
+        case 'Number':
+          return 'double';
+        case 'Object':
+          return 'object';
+        case 'String':
+          return 'string';
+      }
+
+      return type;
+    }
+
     var returnDesc;
 
     // Some parameters need to be altered; eventually most of this should 
     // be removed.
     var accepts = routeHelper.convertAcceptsToSwagger(route, classDef);
     var returns = routeHelper.convertReturnsToSwagger(route, classDef);
+    var responseMessages = [
+      {
+        code: 200,
+        message: 'Request was successful',
+        responseModel: returns.model || prepareDataType(returns.type) || 'void'
+      }
+    ];
+    if (route.errors) {
+      responseMessages.push.apply(responseMessages, route.errors);
+    }
 
     debug('route %j', route);
 
@@ -128,17 +187,15 @@ var routeHelper = module.exports = {
       // `items` and `format` fields.
       operations: [routeHelper.extendWithType({
         method: routeHelper.convertVerb(route.verb),
+        deprecated: route.deprecated,
         // [rfeng] Swagger UI doesn't escape '.' for jQuery selector
         nickname: route.method.replace(/\./g, '_'), 
-        // Per the spec:
-        // https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#523-operation-object
-        // This is the only object that may have a type of 'void'.
-        type: returns.model || returns.type || 'void',
-        parameters: accepts,
-        // TODO(schoon) - We don't have descriptions for this yet.
-        responseMessages: [], 
         summary: route.description, // TODO(schoon) - Excerpt?
-        notes: '' // TODO(schoon) - `description` metadata?
+        notes: route.notes, // TODO(schoon) - `description` metadata?
+        consumes: ['application/json', 'application/xml', 'text/xml'],
+        produces: ['application/json', 'application/javascript', 'application/xml', 'text/javascript', 'text/xml'],
+        parameters: accepts,
+        responseMessages: responseMessages
       })]
     };
 
@@ -192,15 +249,21 @@ var routeHelper = module.exports = {
       }
 
       var out = {
-        paramType: paramType || type,
         name: name,
-        description: accepts.description,
-        type: accepts.type,
         required: !!accepts.required,
+        paramType: paramType || type,
+        type: accepts.type,
+        $ref: accepts.model,
+        items: accepts.items,
+        uniqueItems: accepts.uniqueItems,
+        format: accepts.format,
+        pattern: accepts.pattern,
         defaultValue: accepts.defaultValue,
+        enum: accepts.enum,
         minimum: accepts.minimum,
         maximum: accepts.maximum,
-        allowMultiple: false
+        allowMultiple: accepts.allowMultiple,
+        description: accepts.description
       };
 
       out = routeHelper.extendWithType(out);

lib/swagger.js

@@ -27,8 +27,8 @@ function Swagger(loopbackApplication, swaggerApp, opts) {
     basePath: loopbackApplication.get('restApiRoot') || '/api',
     resourcePath: 'resources',
     // Default consumes/produces
-    consumes: ['application/json', 'application/x-www-form-urlencoded'],
-    produces: ['application/json'],
+    consumes: ['application/json', 'application/x-www-form-urlencoded', 'application/xml', 'text/xml'],
+    produces: ['application/json', 'application/javascript', 'application/xml', 'text/javascript', 'text/xml'],
     version: getVersion()
   });
 
@@ -100,9 +100,9 @@ function addRoute(app, uri, doc, opts) {
     // know that header at the time the data is built.
     if (hasBasePath) {
       var headers = req.headers;
-      var host = headers.Host || headers.host;
-      doc.basePath = (opts.protocol || req.protocol) + '://' + 
-        host + initialPath;
+      var host = headers['x-forwarded-host'] || headers['X-Forwarded-Host'] || headers.Host || headers.host;
+      var protocol = headers['x-forwarded-proto'] || headers['X-Forwarded-Proto'] || opts.protocol || req.protocol
+      doc.basePath = protocol + '://' + host + initialPath;
     }
     res.status(200).send(doc);
   });
@@ -118,13 +118,14 @@ function generateResourceDoc(opts) {
   return {
     swaggerVersion: opts.swaggerVersion,
     apiVersion: opts.version,
-    apis: [],
     // See https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#513-info-object
-    info: opts.apiInfo
+    info: opts.apiInfo,
     // TODO Authorizations
     // https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#514-authorizations-object
-    // TODO Produces/Consumes
-    // https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#52-api-declaration
+    consumes: ['application/json', 'application/xml', 'text/xml'],
+    produces: ['application/json', 'application/javascript', 'application/xml', 'text/javascript', 'text/xml'],
+    apis: [],
+    models: opts.models
   };
 }
 
@@ -137,7 +138,7 @@ function getVersion() {
   try {
     version = require(path.join(process.cwd(), 'package.json')).version;
   } catch(e) {
-    version = '';
+    version = '1';
   }
   return version;
 }

package.json

@@ -21,7 +21,7 @@
     "url": "https://github.com/strongloop/loopback-explorer/issues"
   },
   "devDependencies": {
-    "loopback": "1.x",
+    "loopback": "git+https://github.com/shelbys/loopback.git",
     "mocha": "~1.20.1",
     "supertest": "~0.13.0",
     "chai": "~1.9.1"
@@ -31,7 +31,7 @@
     "url": "https://github.com/strongloop/loopback-explorer/blob/master/LICENSE"
   },
   "dependencies": {
-    "swagger-ui": "~2.0.18",
+    "swagger-ui": "git+https://github.com/shelbys/swagger-ui.git",
     "debug": "~1.0.3",
     "lodash.clonedeep": "^2.4.1",
     "lodash.defaults": "^2.4.1",

public/css/loopbackStyles.css

@@ -34,6 +34,11 @@
   color: #080;
 }
 
+.contentWell {
+    padding-left: 30px;
+    padding-right: 30px;
+}
+
 /* 
 FIXME: Separate the overrides from the rest of the styles, rather than override screen.css entirely.
 */