1.0.2 • Published 2 years ago

@solace-community/asyncapi-to-postman v1.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

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

FlagDescriptionTypeDefault
-v, --versionOutputs the version number
-h, --hostDestination Solace PubSub+ Broker in the form of host:port<host>:<port>http://localhost:9000
-u, --userDestination Solace PubSub+ Broker username:password<username>:<password>default:default
-s, --sempDestination Solace PubSub+ Broker SEMP credentials<username>:<password>admin:admin
-o, --outputDestination Solace PubSub+ Broker SEMP credentials<username>:<password>admin:admin
--helpOutput 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