api2swagger/lib/questions/aboutq.js

Generate Swagger 2.0 (Open API) spec from Curl like API Call.

var inquirer = require("inquirer");

var infoq = [
  { name: 'title',     message: 'Title of Swagger Spec ?', default: 'API Program Title.'},
  { name: 'description',     message: 'Description of Swagger Spec ?', default: 'API Program description'},
  { name: 'termsOfService', message: 'Terms of Service URL ?', default: 'http://example.com/about/terms'},
  { name: 'version', message: 'Version of your API Program ?', default: '0.0.1'},
  { name: 'contactName',     message: 'Contact Name?', default: 'API Docs'},
  { name: 'contactUrl',     message: 'Contact URL ?', default: 'http://example.com/contact'},
  { name: 'contactEmail', message: 'Contact Email ?', default: 'apidocs@example.com'},
  { name: 'licenseName',     message: 'License Name ?', default: 'Apache 2.0'},
  { name: 'licenseUrl',     message: 'License URL ?', default: 'http://example.com'}
];

var httpsq = [
  {name: 'https', message: 'Does your API support https ?', type: 'confirm'}
];

var httpq = [
  {name: 'http', message: 'Does your API support http ?', type: 'confirm'}
];

var basepathq = [
  {
    type: "list",
    name: "basePath",
    message: "Pick Base Path from your API ?"
  }
];

module.exports.infoQ = function(data, callback) {
  inquirer.prompt(infoq, function( answers ) {
    var info = {};
    info.description = answers.description;
    info.title = answers.title;
    info.version = answers.version;
    info.termsOfService = answers.termsOfService;
    info.contact = {};
    info.contact.name = answers.contactName;
    info.contact.url = answers.contactUrl;
    info.contact.email = answers.contactEmail;
    info.license = {};
    info.license.name = answers.licenseName;
    info.license.url = answers.licenseUrl;
    callback(info);
  });
}



module.exports.protocolsQ = function(data, callback) {
  if (data == 'http') {
    var questions = httpsq;
  } else {
    var questions = httpq;
  }
  inquirer.prompt(questions, function( answers ) {
    callback(answers);
  });
}

module.exports.basePathsQ = function(options, callback) {
  basepathq[0].choices = options;
  inquirer.prompt(basepathq, function( answers ) {
    callback(answers);
  });
}