AsyncAPI Converter
Convert AsyncAPI documents older to newer versions.
Installation
npm i -g asyncapi-converter
Usage
From CLI
Minimal example:
asyncapi-converter streetlights.yml # Result: asyncapi: '2.0.0'channels:...
Specify the application id:
asyncapi-converter --id=urn:com.asynapi.streetlights streetlights.yml # Result: asyncapi: '2.0.0'id: 'urn:com.asynapi.streetlights'...
Save the result in a file:
asyncapi-converter streetlights.yml > streetlights2.yml
As a package
const convert = try const asyncapi = fs console catch e console
Known missing features
- When converting from 1.x to 2.x, Streaming APIs (those using
stream
instead oftopics
orevents
) are converted correctly but information about framing type and delimiter is missing until a protocolInfo for that purpose is created.