@asyncapi/app-relations-discovery

Applications Relation Finder

:warning: This package is under construction.

Overview

An official library that focuses on finding and analyzing the relationships between AsyncAPI Documents to later output consolidated information about the system architecture. Output format would be customizable and available in different formats like uml, mermaid.js and other.

Install

npm install @asyncapi/app-relations-discovery

API

• For default output syntax

const defaultOutput = appRelationsDiscovery.getRelations(...docs);

• For mermaid Flowchart

const mermaidFlowchart = appRelationsDiscovery.getRelations(...docs,{syntax:'mermaid'});

• For plantUML classDiagram

const plantUMLClassDiagram = appRelationsDiscovery.getRelations(...docs,{syntax:'plantUML'});

• For reactFlow nodes

const reactFlowNodes = appRelationsDiscovery.getRelations(...docs,{syntax:'reactFlow'});