render

Render PlantUML source to SVG or PNG

The core function. Send PlantUML source text; receive the rendered diagram. format defaults to svg. PlantUML syntax errors still return an image (200) containing the error message - call POST /api/validate first (or use /api/render/batch, which validates per item) to get a machine-readable error instead. Responses carry a strong ETag and Cache-Control: public, max-age=86400, immutable; send If-None-Match to receive 304 for a repeated source. Every response carries RateLimit-* headers.

post/api/render

Request

  • Base URL: https://uml.singsk.com
  • URL: https://uml.singsk.com/api/render
  • Auth: none declared

Query parameters

format'svg' | 'png'

Used when the body is text/plain; JSON body format field wins otherwise.

Request body

textstring required

PlantUML source, including @start/@end directives

format'svg' | 'png'

Response

Rendered diagram

Changes

No recorded changes to this operation across all 1 revision of this API.