puml

Documentation

Index

• func C4ContainerPuml(arcData model.ArcType, targets ...string) (string, error)
• func C4ContextPuml(arcData model.ArcType, targets ...string) (string, error)
• type C4Context
• type C4Neighbor
• type C4Relation
• type C4SystemContainer

Functions

func C4ContainerPuml

func C4ContainerPuml(arcData model.ArcType, targets ...string) (string, error)

C4ContainerPuml generate the C4 plantUml code from ArcType data to draw Container diagram for target Systems

func C4ContextPuml

func C4ContextPuml(arcData model.ArcType, targets ...string) (string, error)

C4ContextPuml generate puml code for Context diagram using the given ArcType data

Types

type C4Context

type C4Context struct {
	Title     string
	Arc       model.ArcType
	Relations []C4Relation
}

C4Context type hold all data structure to render Context diagrams

type C4Neighbor

type C4Neighbor struct {
	Name string
	Desc string
}

C4Neighbor is the generic presentation for any partnering elements

type C4Relation

type C4Relation struct {
	Subject     string
	Object      string
	Pointer     string
	PointerTech string
}

C4Relation is the data struct to draw relation in C4

type C4SystemContainer

type C4SystemContainer struct {
	SystemName string
	Users      []model.User
	Containers []model.Container
	Relations  []C4Relation
	Neighbors  []C4Neighbor
}

C4SystemContainer type hold data structure to render Container diagrams