@asyncapi/converter
v1.5.1
Published
Convert AsyncAPI documents from older to newer versions.
Downloads
54,915
Readme
AsyncAPI Converter
Convert AsyncAPI documents older to newer versions and you can also convert OpenAPI documents to AsyncAPI documents.
- Installation
- Usage
- Conversion 2.x.x to 3.x.x
- Known missing features
- Development
- Contribution
- Contributors ✨
Installation
npm i @asyncapi/converter
Usage
From CLI
To convert an AsyncAPI document in the console needs the official AsyncAPI CLI.
If you don't have CLI installed, run this command to install the CLI globally on your system:
npm install -g @asyncapi/cli
Minimal usage example with output given:
asyncapi convert streetlights.yml -o streetlights2.yml
# Result:
asyncapi: '2.0.0'
channels:
...
Convert to a specific version:
asyncapi convert streetlights.yml -o streetlights2.yml -t 2.3.0
# Result:
asyncapi: '2.3.0'
channels:
...
In JS
const fs = require('fs');
const { convert } = require('@asyncapi/converter')
try {
const asyncapi = fs.readFileSync('streetlights.yml', 'utf-8')
console.log(convert(asyncapi, '2.6.0'));
} catch (e) {
console.error(e);
}
In TS
import { convert } from '@asyncapi/converter';
import type { ConvertVersion, ConvertOptions } from '@asyncapi/converter';
try {
const toVersion: ConvertVersion = '2.6.0';
const asyncapi = fs.readFileSync('streetlights.yml', 'utf-8')
console.log(convert(asyncapi, toVersion));
} catch (e) {
console.error(e)
}
Conversion 2.x.x to 3.x.x
NOTE: This feature is still WIP, and is until the final release of
3.0.0
.
Conversion to version 3.x.x
from 2.x.x
has several assumptions that should be known before converting:
The input must be valid AsyncAPI document.
External references are not resolved and converted, they remain untouched, even if they are incorrect.
In version
3.0.0
, the channel identifier is no longer its address, but due to the difficulty of defining a unique identifier, we still treat the address as an identifier. If there is a need to assign an identifier other than an address, anx-channelId
extension should be defined at the level of the given channel.# 2.x.x channels: users/signup: x-channelId: 'userSignUp' ... users/logout: ... # 3.0.0 channels: userSignUp: ... users/logout: ...
The
publish
operation is treated as areceive
action, andsubscribe
is treated as asend
action. Conversion by default is embraced from the application perspective. If you want to change this logic, you need to specifyv2tov3.pointOfView
configuration asclient
.If the operation does not have an
operationId
field defined, the unique identifier of the operation will be defined as a combination of the identifier of the channel on which the operation was defined + the type of operation,publish
orsubscribe
. Identical situation is with messages. However, here the priority is themessageId
field and then the concatenation{publish|subscribe}.messages.{optional index of oneOf messages}
.# 2.x.x channels: users/signup: publish: message: ... subscribe: operationId: 'userSignUpEvent' message: oneOf: - messageId: 'userSignUpEventMessage' ... - ... # 3.0.0 channels: users/signup: messages: publish.message: ... userSignUpEventMessage: ... userSignUpEvent.message.1: ... operations: users/signup.publish: action: receive ... userSignUpEvent: action: send ...
Security requirements that use scopes are defined in the appropriate places inline, the rest as a reference to the
components.securitySchemes
objects.If servers are defined at the channel level, they are converted as references to the corresponding objects defined in the
servers
field.Channels and servers defined in components are also converted (unless configured otherwise).
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. - When converting from 2.x to 3.x, and
parameter.schema
is defined with a reference, it will NOT look into the schema reference and include any relevant keywords for the v3 parameter. It will just create an empty parameter but leave the schema in the components section as is.# 2.x.x channels: "{myParameter}": parameters: myParameter: schema: $ref: "#/components/schemas/mySchema" components: schemas: mySchema: enum: ["test"] default: "test" examples: ["test"] # 3.0.0 channels: "{myParameter}": parameters: myParameter: {} components: schemas: mySchema: enum: ["test"] default: "test" examples: ["test"]
OpenAPI 3.0 to AsyncAPI 3.0 Conversion
The converter now supports transformation from OpenAPI 3.0 to AsyncAPI 3.0. This feature enables easy transition of existing OpenAPI 3.0 documents to AsyncAPI 3.0.
To use this new conversion feature:
const fs = require('fs');
const { convertOpenAPI } = require('@asyncapi/converter')
try {
const openapi = fs.readFileSync('openapi.yml', 'utf-8')
const asyncapi = convertOpenAPI(openapi, '3.0.0', { from: 'openapi' });
console.log(asyncapi);
} catch (e) {
console.error(e);
}
When converting from OpenAPI to AsyncAPI you can now specify the perspective of the conversion using the perspective
option. This allows you to choose whether the conversion should be from an application or client point of view
const { convertOpenAPI } = require('@asyncapi/converter')
try {
const asyncapi2 = fs.readFileSync('asyncapi2.yml', 'utf-8')
const asyncapi3 = convertOpenAPI(asyncapi2, '3.0.0', { openAPIToAsyncAPI: { perspective: 'client' } });
console.log(asyncapi3);
} catch (e) {
console.error(e);
}
The perspective option can be set to either 'server' (default) or 'client'.
With
server
perspective:action
becomesreceive
With
client
perspective:action
becomessend
Limitations
- External to internal references: The converter does not support scenarios where an external schema file references internal components of the OpenAPI document. In such cases, manual adjustment of the converted document may be necessary.
Development
- Setup project by installing dependencies
npm install
- Write code and tests.
- Make sure all tests pass
npm test
Contribution
Read CONTRIBUTING guide.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!