Converts Postman-SDK Request into code snippet for cURL.
To run Code-Gen, ensure that you have NodeJS >= v8. A copy of the NodeJS installable can be downloaded from
The module will expose an object which will have property convert which is the function for converting the Postman-SDK request to cURL code snippet and getOptions function which returns an array of supported options.
Convert function takes three parameters
-
request- Postman-SDK Request Object -
options- options is an object which has following propertiesindentType- String denoting type of indentation for code snippet. eg: 'Space', 'Tab'indentCount- The number of indentation characters to add per code leveltrimRequestBody- Trim request body fieldsfollowRedirect- Boolean denoting whether to redirect a requestrequestTimeout- Integer denoting time after which the request will bail out in milli-secondsmultiLine- Boolean denoting whether to output code snippet with multi line breakslongFormat- Boolean denoting whether to use longform cURL options in snippetquoteType- String denoting the quote type to use (single or double) for URL
-
callback- callback function with first parameter as error and second parameter as string for code snippet
var request = new sdk.Request('www.google.com'), //using postman sdk to create request
options = {
indentCount: 3,
indentType: 'Space',
requestTimeout: 200,
trimRequestBody: true,
multiLine: true,
followRedirect: true,
longFormat: true,
quoteType: 'single'
};
convert(request, options, function(error, snippet) {
if (error) {
// handle error
}
// handle snippet
});This function returns a list of options supported by this codegen.
var options = getOptions();
console.log(options);
// output
// [
// {
// name: 'Set indentation count',
// id: 'indentCount',
// type: 'positiveInteger',
// default: 2,
// description: 'Set the number of indentation characters to add per code level'
// },
// ...
// ]-
Since Postman-SDK Request object doesn't provide complete path of the file, it needs to be manually inserted in case of uploading a file.
-
This module doesn't support cookies.