Adding support for APIs in definition file. (#72)

Author: Jesse O'Brien

bin/swagger-jsdoc.js

@@ -111,8 +111,18 @@ fs.readFile(program.definition, 'utf-8', function(err, data) {
   }
 
   // Continue only if arguments provided.
-  if (!program.args.length) {
-    return console.log('You must provide arguments for reading APIs.');
+  if (!swaggerDefinition.apis && !program.args.length) {
+    console.log('You must provide sources for reading API files.');
+    // jscs:disable maximumLineLength
+    return console.log('Either add filenames as arguments, or add an api key in your definitions file.');
+  }
+
+  // If there's no argument passed, but the user has defined Apis in
+  // the definition file, pass them them onwards.
+  if (program.args.length === 0 &&
+    swaggerDefinition.apis &&
+    swaggerDefinition.apis instanceof Array) {
+    program.args = swaggerDefinition.apis;
   }
 
   // If watch flag is turned on, listen for changes.

docs/CLI.md

@@ -13,13 +13,15 @@ $ swagger-jsdoc -h
 
 #### Specify a definition file
 
+Swagger-jsdoc will read the `api` array in your definition file by default for file paths it should read.
+
 ```
-$ swagger-jsdoc -d swaggerDef.js
+$ swagger-jsdoc -d swaggerDef.js -o doc.json
 ```
 
 This could be any .js or .json file which will be `require()`-ed and parsed/validated as JSON.
 
-#### Specify input files
+#### Specify input files (optional)
 
 ```
 $ swagger-jsdoc route1.js route2.js

test/cli-test.js

@@ -80,7 +80,7 @@ describe('command line interface', function () {
       if (error) {
         throw new Error(error, stderr);
       }
-      expect(stdout).to.contain('You must provide arguments for reading APIs.');
+      expect(stdout).to.contain('You must provide sources for reading API files.');
       done();
     });
   });
@@ -100,6 +100,21 @@ describe('command line interface', function () {
     });
   });
 
+  it('should create swagger.json by default when the API input is from definition file', function (done) {
+    var goodInput = process.env.PWD + '/bin/swagger-jsdoc.js -d test/fixtures/api_definition.js';
+    exec(goodInput, function (error, stdout, stderr) {
+      if (error) {
+        throw new Error(error, stderr);
+      }
+      expect(stdout).to.contain('Swagger specification is ready.');
+      expect(stderr).to.not.contain('You are using properties to be deprecated');
+      var specification = fs.statSync('swagger.json');
+      // Check that the physical file was created.
+      expect(specification.nlink).to.be.above(0);
+      done();
+    });
+  });
+
   it('should accept custom configuration for output specification', function (done) {
     var goodInput = process.env.PWD + '/bin/swagger-jsdoc.js -d example/swaggerDef.js -o customSpec.json example/routes.js';
     exec(goodInput, function (error, stdout, stderr) {

test/fixtures/api_definition.js

@@ -0,0 +1,8 @@
+module.exports = {
+  info: { // API informations (required)
+    title: 'Hello World', // Title (required)
+    version: '1.0.0', // Version (required)
+    description: 'A sample API', // Description (optional)
+  },
+  apis: ['./**/*/routes.js']
+};