alihan/fastapi-openapi-to-postman
1
0
Fork 0
mirror of https://github.com/postmanlabs/openapi-to-postman.git synced 2022-11-29 22:05:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

setting default values of options through getOptions function

Browse Source
This commit is contained in:
Dhroov7
2019-10-21 13:41:27 +05:30
parent d351e79fee
commit 01bbb065f5
2 changed files with 89 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
index.js
View File

@@ -1,4 +1,4 @@
var convert = require('./lib/convert.js'),
var converter = require('./lib/convert.js'),
validate = require('./lib/validate.js'),
fs = require('fs');
@@ -7,7 +7,7 @@ module.exports = {
if (input.type === 'string' || input.type === 'json') {
// no need for extra processing before calling the converter
// string can be JSON or YAML
return convert(input.data, options, cb);
return converter.convert(input.data, options, cb);
}
else if (input.type === 'file') {
return fs.readFile(input.data, 'utf8', function(err, data) {
@@ -16,7 +16,7 @@ module.exports = {
}
// if the file contents were JSON or YAML
return convert(data, options, cb);
return converter.convert(data, options, cb);
});
}
return cb(null, {
@@ -52,56 +52,6 @@ module.exports = {
},
getOptions: function() {
return [
{
name: 'Toggle for faking schema',
id: 'schemaFaker',
type: 'boolean',
default: true,
description: 'Option for Fake the schema using json or xml schema faker'
},
{
name: 'Toggle for collapsing folder for long routes',
id: 'collapseLongFolders',
type: 'boolean',
default: true,
description: 'Collapse folders in case of long routes leading to unnecessary folders'
},
{
name: 'Set root request body type',
id: 'rootRequestBodyType',
type: 'string',
default: 'schema',
description: 'Option for setting root request body between schema or example'
},
{
name: 'Set example request and response body type',
id: 'exampleBodyType',
type: 'string',
default: 'example',
description: 'Option for setting example request and response body between schema or example'
},
{
name: 'Set folder strategy',
id: 'folderStrategy',
type: 'string',
default: 'paths',
description: 'Option for setting folder creating strategy between paths or tags'
},
{
name: 'Set indent character',
id: 'indentCharacter',
type: 'string',
default: ' ',
description: 'Option for setting indentation character'
},
{
name: 'Set request name source',
id: 'requestNameSource',
type: 'string',
default: 'fallback',
description: 'Option for setting source for a request name'
}
];
return converter.getOptions();
}
};

79
lib/convert.js
View File

@@ -47,6 +47,7 @@ var sdk = require('postman-collection'),
convert: function (data, options, callback) {
var validation = util.parseSpec(data),
openapi = {},
definedOptions = converter.getOptions(),
description,
contact;
@@ -57,12 +58,18 @@ var sdk = require('postman-collection'),
// set default options
util.options = {
requestNameSource: (options.hasOwnProperty('requestNameSource') ? options.requestNameSource : 'fallback'),
schemaFaker: (options.hasOwnProperty('schemaFaker') ? options.schemaFaker : true),
indentCharacter: (options.hasOwnProperty('indentCharacter') ? options.indentCharacter : ' '),
collapseLongFolders: (options.hasOwnProperty('collapseLongFolders') ? options.collapseLongFolders : true),
rootRequestBodyType: (options.hasOwnProperty('rootRequestBodyType') ? options.rootRequestBodyType : 'schema'),
exampleBodyType: (options.hasOwnProperty('exampleBodyType') ? options.exampleBodyType : 'example')
requestNameSource: (options.hasOwnProperty('requestNameSource') ? options.requestNameSource :
definedOptions[0].default),
schemaFaker: (options.hasOwnProperty('schemaFaker') ? options.schemaFaker :
definedOptions[1].default),
indentCharacter: (options.hasOwnProperty('indentCharacter') ? options.indentCharacter :
definedOptions[2].default),
collapseLongFolders: (options.hasOwnProperty('collapseLongFolders') ? options.collapseLongFolders :
definedOptions[3].default),
rootRequestBodyType: (options.hasOwnProperty('rootRequestBodyType') ? options.rootRequestBodyType :
definedOptions[4].default),
exampleBodyType: (options.hasOwnProperty('exampleBodyType') ? options.exampleBodyType :
definedOptions[5].default)
};
// @TODO - Have to handle global level security scheme
@@ -167,11 +174,65 @@ var sdk = require('postman-collection'),
data: this.generatedStore.collection.toJSON()
}]
});
},
getOptions: function() {
return [
{
name: 'Set request name source',
id: 'requestNameSource',
type: 'string',
default: 'fallback',
description: 'Option for setting source for a request name'
},
{
name: 'Toggle for faking schema',
id: 'schemaFaker',
type: 'boolean',
default: true,
description: 'Option for Fake the schema using json or xml schema faker'
},
{
name: 'Set indent character',
id: 'indentCharacter',
type: 'string',
default: ' ',
description: 'Option for setting indentation character'
},
{
name: 'Toggle for collapsing folder for long routes',
id: 'collapseLongFolders',
type: 'boolean',
default: true,
description: 'Collapse folders in case of long routes leading to unnecessary folders'
},
{
name: 'Set root request body type',
id: 'rootRequestBodyType',
type: 'string',
default: 'schema',
description: 'Option for setting root request body between schema or example'
},
{
name: 'Set example request and response body type',
id: 'exampleBodyType',
type: 'string',
default: 'example',
description: 'Option for setting example request and response body between schema or example'
},
{
name: 'Set folder strategy',
id: 'folderStrategy',
type: 'string',
default: 'paths',
description: 'Option for setting folder creating strategy between paths or tags'
}
];
}
};
module.exports = function(json, options, callback) {
module.exports = {
convert: function(json, options, callback) {
try {
converter.convert(json, options, callback);
}
@@ -188,4 +249,6 @@ module.exports = function(json, options, callback) {
callback(e);
}
}
},
getOptions: converter.getOptions
};