kroki

Documentation

Index

• type KrokiClient
  • func NewKrokiClient(host string) *KrokiClient
  • func (kc *KrokiClient) GetDiagramURL(diagramType, diagramSource string, format model.OutputFormat) (string, error)
  • func (kc *KrokiClient) RenderDiagram(diagramType, diagramSource string, format model.OutputFormat) (*KrokiResult, error)
• type KrokiResult

Types

type KrokiClient

type KrokiClient struct {
	Host string
}

func NewKrokiClient

func NewKrokiClient(host string) *KrokiClient

func (*KrokiClient) GetDiagramURL

func (kc *KrokiClient) GetDiagramURL(diagramType, diagramSource string, format model.OutputFormat) (string, error)

GetDiagramURL generates a URL for the Kroki API to fetch the diagram. It encodes the diagram source and appends it to the Kroki host URL.

func (*KrokiClient) RenderDiagram

func (kc *KrokiClient) RenderDiagram(diagramType, diagramSource string, format model.OutputFormat) (*KrokiResult, error)

RenderDiagram sends diagram code to the Kroki server and returns both image base64 and a direct URL.

type KrokiResult

type KrokiResult struct {
	ImageContent []byte `json:"-"` // The image content in base64 format
	MIMEType     string `json:"-"`
}