Exclude swagger serving from library

Author: chdanielmueller

example/app.js

@@ -4,8 +4,9 @@
 // Dependencies
 var express = require('express');
 var bodyParser = require('body-parser');
+var swaggerTools = require('swagger-tools');
 var routes = require('./routes');
-var swagger = require('../');
+var swaggerJSDoc = require('../');
 
 
 // Initialize express
@@ -32,15 +33,29 @@ var swaggerDefinition = {
 
 // Options for the swagger docs
 var options = {
-  apiDocs: '/api-docs.json', // Default: '/api-docs', optional
-  swaggerUi: '/docs', // Path to the swaggerUI (default: '/docs', optional)
   swaggerDefinition: swaggerDefinition, // Import swaggerDefinitions
   apis: ['./example/routes.js'], // Path to the API docs
 };
 
 
-// Initialize swagger-jsdoc
-swagger.init(app, options);
+// Initialize swagger-jsdoc -> returns validated swagger spec in json format
+var swaggerSpec = swaggerJSDoc(options);
+
+
+// Swagger Tools Options
+var swaggerToolsUIOptions = {
+  apiDocs: '/api-docs.json',
+  swaggerUi: '/docs',
+};
+
+
+// Initialize the Swagger middleware
+swaggerTools.initializeMiddleware(swaggerSpec,
+  function(middleware) {
+    // Serve the Swagger documents and Swagger UI
+    app.use(middleware.swaggerUi(swaggerToolsUIOptions));
+  }
+);
 
 
 // Set up the routes

lib/index.js

@@ -7,7 +7,7 @@ var fs = require('fs');
 var path = require('path');
 var doctrine = require('doctrine');
 var jsYaml = require('js-yaml');
-var swaggerTools = require('swagger-tools');
+var parser = require('swagger-parser');
 
 
 /**
@@ -84,18 +84,14 @@ function addDataToSwaggerObject(swaggerObject, swaggerJsDocComments) {
 }
 
 
-// This is the Swagger object that conforms to the Swagger 2.0 specification.
-module.exports.swaggerObject = [];
-
-
 /**
- * Initializes the module. This is intended to be called only once.
+ * Generates the swagger spec
  * @function
- * @param {object} app - Express application
  * @param {object} options - Configuration options
- * @requires swagger-tools
+ * @returns {array} Swagger spec
+ * @requires swagger-parser
  */
-module.exports.init = function(app, options) {
+module.exports = function(options) {
   /* istanbul ignore if */
   if (!options) {
     throw new Error('\'options\' is required.');
@@ -106,37 +102,23 @@ module.exports.init = function(app, options) {
   }
 
   // Build basic swagger json
-  module.exports.swaggerObject = options.swaggerDefinition;
-  module.exports.swaggerObject.swagger = '2.0';
-  module.exports.swaggerObject.paths = {};
+  var swaggerObject = [];
+  swaggerObject = options.swaggerDefinition;
+  swaggerObject.swagger = '2.0';
+  swaggerObject.paths = {};
 
   // Parse the documentation in the APIs array.
   for (var i = 0; i < options.apis.length; i = i + 1) {
     var jsDocComments = parseApiFile(options.apis[i]);
     var swaggerJsDocComments = filterJsDocComments(jsDocComments);
-    addDataToSwaggerObject(module.exports.swaggerObject, swaggerJsDocComments);
+    addDataToSwaggerObject(swaggerObject, swaggerJsDocComments);
   }
 
-  var swaggerToolsUIOptions = {
-    apiDocs: options.apiDocs,
-    swaggerUi: options.swaggerUi,
-  };
-
-  // Initialize the Swagger middleware
-  swaggerTools.initializeMiddleware(module.exports.swaggerObject,
-    function(middleware) {
-      // Interpret Swagger resources and attach metadata to request
-      // must be first in swagger-tools middleware chain
-      app.use(middleware.swaggerMetadata());
-
-      // Validate Swagger requests
-      app.use(middleware.swaggerValidator());
-
-      // Route validated requests to appropriate controller
-      app.use(middleware.swaggerRouter());
-
-      // Serve the Swagger documents and Swagger UI
-      app.use(middleware.swaggerUi(swaggerToolsUIOptions));
+  parser.parse(swaggerObject, function(err, api) {
+    if (!err) {
+      swaggerObject = api;
     }
-  );
+  });
+
+  return swaggerObject;
 };

package.json

@@ -29,7 +29,7 @@
   "dependencies": {
     "doctrine": "^0.6.4",
     "js-yaml": "^3.3.1",
-    "swagger-tools": "^0.8.7"
+    "swagger-parser": "^2.4.2"
   },
   "devDependencies": {
     "body-parser": "^1.12.4",
@@ -39,6 +39,7 @@
     "mocha": "^2.2.5",
     "mocha-jscs": "^1.1.0",
     "mocha-jshint": "^2.2.3",
-    "supertest": "^1.0.1"
+    "supertest": "^1.0.1",
+    "swagger-tools": "^0.8.7"
   }
 }