Engine + Framework

PlantUML with Nuxt

Integration guide for teams shipping diagram rendering in Nuxt.

PlantUML usage guidance

Best for

  • UML modeling
  • Class and sequence diagrams
  • Architecture documentation

Syntax tip

Use explicit participant aliases and avoid deeply nested groups for better readability.

Quick start

Create a Nuxt server endpoint that forwards PlantUML source to ChartQuery and returns image output.

Recommended flow

  1. Store your PlantUML source in code or markdown.
  2. Send source to a server-side endpoint backed by ChartQuery.
  3. Render returned SVG/PNG in Nuxt pages and docs.

Typical Nuxt integration path: /server/api/diagram.post.ts

PlantUML integration details

FieldValue
EnginePlantUML
FrameworkNuxt

Nuxt implementation checklist

  • Create Nitro server endpoint
  • Centralize request validation
  • Render output in pages using async data

PlantUML source example

@startuml
actor User
User -> API: Request
API --> User: Response
@enduml

PlantUML in Nuxt: quick comparison

Why teams usually prefer the ChartQuery API pattern over direct client-side rendering for PlantUML in Nuxt.

Feature
Nuxt native setup
ChartQuery API setup
Server-side rendering without browser dependencies
Unified output (SVG/PNG) for docs, dashboards, and emails
Consistent rendering across environments
Works with CI/CD pipelines
Fits backend-first architectures
Single rendering workflow across multiple frameworks

Ship PlantUML in Nuxt faster

Use ChartQuery to standardize diagram rendering across your stack with one API, one workflow, and predictable output quality.

Get started with ChartQuery

Start generating charts today

No API key required to get started. Generate charts, diagrams, and more with a single HTTP request.

Get StartedView Pricing