Converts Spring REST Docs cURL snippets to Postman and Insomnia collections
npm install restdocs-2-postmanbash
npm install -g restdocs-to-postman
`
For programmatic usage, install in project
`bash
npm install --save restdocs-to-postman
`
Command Line Usage
`shell
restdocs-to-postman --input generated-snippets --export-format postman --determine-folder secondLastFolder --output postman-collection.json
`
From the given folder, all folders are recursively scanned for curl-request.adoc and curl-request.md files.
Requests can be sorted into folders with --determine-folder secondLastFolder.
The function secondLastFolder is the only one for now and puts a request from ../items/get/curl-request.adoc into a folder called item.
Host and header replacements can be used with --replacements replacements.json.
See replacement-example.json
for an example of a replacement file.
Programmatic Usage
`javascript
const converter = require('restdocs-to-postman');
// Convert Spring REST Docs cURL commands to Postman/Insomnia collections
const folderToScan = './target/generated-snippets';
const exportFormat = 'postman';
const replacements = {
host: {
before: 'http://localhost:8080',
after: '{{host}}'
},
headers: [
{
name: 'Authorization',
newValue: '{{oauth2Token}}'
}
]
};
const output = converter.convert({folderToScan, exportFormat, replacements});
// Print the result
console.log(output);
`
Running Tests
Run all tests
`shell
npm test
``