You are viewing a previous version of KrakenD Enterprise Edition (v2.1), go to the
latest version
Document updated on May 7, 2021
Generate Postman collections
The Postman Swagger generator is a command line utility embedded in the KrakenD binary, offering the automatic generation of Postman collections based on the KrakenD configuration.
Generating the Postman collection
The command needed to generate the Postman collection is krakend generate postman
:
Command to start KrakenD
$krakend generate postman -h
╓▄█ ▄▄▌ ╓██████▄µ
▐███ ▄███╨▐███▄██H╗██████▄ ║██▌ ,▄███╨ ▄██████▄ ▓██▌█████▄ ███▀╙╙▀▀███╕
▐███▄███▀ ▐█████▀"╙▀▀"╙▀███ ║███▄███┘ ███▀""▀███ ████▀╙▀███H ███ ╙███
▐██████▌ ▐███⌐ ,▄████████M║██████▄ ║██████████M███▌ ███H ███ ,███
▐███╨▀███µ ▐███ ███▌ ,███M║███╙▀███ ███▄```▄▄` ███▌ ███H ███,,,╓▄███▀
▐███ ╙███▄▐███ ╙█████████M║██▌ ╙███▄`▀███████╨ ███▌ ███H █████████▀
`` `'`
Version:
Generates the Postman descriptor for the gateway based on the configuration file.
Usage:
krakend generate postman [flags]
Examples:
krakend generate postman -c config.json -o postman.json
Flags:
-h, --help help for postman
Global Flags:
-c, --config string Path to the configuration filename
-d, --debug Enable the debug
-o, --out string Path to the generated result. (default "out.json")
When the output file is generated, you can import it from Postman and share it with your peers.