- getRelations(asyncApiDocs, [options]) ⇒
Promise.<DiscoveredRelations> Validates and analyzes a list of AsyncAPI documents and get applications described by those files
- getMermaidFlowchart(metrics) ⇒
String Generates mermaid flowchart from default output syntax
- getPlantUMLDiagram(metrics) ⇒
String Generates plantUML class diagram from default output syntax
- getReactFlowData(metrics) ⇒
Array Generates reactFlow nodes data from default output syntax
- validate(asyncApiDocs) ⇒
Promise.<Array> Validate and parse given array of AsyncAPI documents.
Validates and analyzes a list of AsyncAPI documents and get applications described by those files
Kind: global function
Returns: Promise.<DiscoveredRelations> - Relations between documents
| Param | Type | Description |
|---|---|---|
| asyncApiDocs | Array.<String> |
An array of stringified AsyncAPI documents |
| [options] | Object |
|
| [options.syntax] | 'default' | 'mermaid' | 'plantUML' | 'reactFlow' |
syntax in which the relation will be generated. |
Generates mermaid flowchart from default output syntax
Kind: global function
Returns: String - Flowchart following mermaid syntax
| Param | Type | Description |
|---|---|---|
| metrics | Object |
Relations between AsyncAPI docs in default output syntax |
Generates plantUML class diagram from default output syntax
Kind: global function
Returns: String - class diagram following plantUML syntax
| Param | Type | Description |
|---|---|---|
| metrics | Object |
Relations between AsyncAPI docs in default output syntax |
Generates reactFlow nodes data from default output syntax
Kind: global function
Returns: Array - reactFlow nodes data
| Param | Type | Description |
|---|---|---|
| metrics | Object |
Relations between AsyncAPI docs in default output syntax |
Validate and parse given array of AsyncAPI documents.
Kind: global function
Returns: Promise.<Array> - parsed AsyncAPI documents
| Param | Type | Description |
|---|---|---|
| asyncApiDocs | Array |
unparsed AsyncAPI documents |