Skip to content

generateAllAPIFlowDiagrams

reference
1 min readUpdated

Kind: Function

Source: atloria-monorepo/libs/parser-core/src/generators/diagrams/api-flow-diagram.generator.ts

Generate flow diagrams for all API endpoints

Signature

ts
function generateAllAPIFlowDiagrams(endpoints: APIEndpointEntity[], allEntities: Entity[], relationships: Relationship[], options: APIFlowDiagramOptions): Array<{ endpointPath: string; method: string; result: APIFlowDiagramResult }>

Parameters

NameType
endpointsAPIEndpointEntity[]
allEntitiesEntity[]
relationshipsRelationship[]
optionsAPIFlowDiagramOptions

Returns: Array<{ endpointPath: string; method: string; result: APIFlowDiagramResult }>

Was this page helpful?

Download as PDF