@solace-community/asyncapi-to-postman

1.0.2 • Public • Published

AsyncAPI to Postman Collections

This utility takes in an asyncAPI file as an input parameter and outputs a Postman collection. Note that the events are converted to POST requests sent to the Solace PubSub+ REST Port

How to run

There are two ways to run this utility

  1. npx @solace-community/asyncapi-to-postman -f <path_to_asyncAPI_file> [OPTIONS] OR
  2. npm install @solace-community/asyncapi-to-postman -g then execute command from anywhere in terminal via asyncapi-to-postman -f <path_to_asyncAPI_file> [OPTIONS]

Below are the following options

Flag Description Type Default
-v, --version Outputs the version number
-h, --host Destination Solace PubSub+ Broker in the form of host:port <host>:<port> http://localhost:9000
-u, --user Destination Solace PubSub+ Broker username:password <username>:<password> default:default
-s, --semp Destination Solace PubSub+ Broker SEMP credentials <username>:<password> admin:admin
-o, --output Destination Solace PubSub+ Broker SEMP credentials <username>:<password> admin:admin
--help Output file name <asyncAPIFileName_collections>

Development

To run this cli tool locally

  1. Clone this repo
  2. npm install
  3. node index --help

Contribution

To contribute to this CLI tool

  1. Fork this repo
  2. Update the package.json version number
  3. Make a PR

/@solace-community/asyncapi-to-postman/

    Package Sidebar

    Install

    npm i @solace-community/asyncapi-to-postman

    Weekly Downloads

    1

    Version

    1.0.2

    License

    ISC

    Unpacked Size

    36.6 kB

    Total Files

    7

    Last publish

    Collaborators

    • tamimi65
    • daniel.wiehl
    • solacecommunity