You can use PlantUML using the online web service to generate images on-the-fly. A online demonstration is available at http://www.plantuml.com/plantuml
, but you can also install it on your own JEE web application server.
If you don't want to install a full JEE application server, you may also choose to run PlantUML PicoWeb Server
The big input field is used to enter your diagram description. You can type in any diagram description, then press the submit button and the diagram will be displayed below. It's a good practice to start your diagram by the
When you validate the diagram, you are redirected to an encoded URL encoding your diagram. The encoded form
is a convenient way to share your diagrams with others because it's shorter than the many lines of a diagram and it can be easily displayed in a browser using the online PlantUML Server.
is the encoded form of:
Bob -> Alice : hello
By default, the PlantUML Server shows the well-known
Bob -> Alice
sample but it's easy to invoke it with an other diagram using its encoded form. Just append
to the URL.
For example, this link http://www.plantuml.com/plantuml/uml/Aov9B2hXil98pSd9LoZFByf9iUOgBial0000
opens the PlantUML Server with a simple Hello World activity diagram.
PlantUML saves the diagram's source code in the generated PNG Metadata in the form of encoded text
. So it is possible to retrieve this source by using the query parameter
, giving it some image URL.
For example, if you want to retrieve the diagram source of the image
use the following server request:
Sounds like magic! No, merely clever engineering :-)
The web service interface of the PlantUML Server is dedicated to developers.
To get a PNG file of a diagram, use the following URL scheme: /plantuml/png/ENCODED
To get a SVG XML file of a diagram, use the following URL scheme: /plantuml/svg/ENCODED
Note that not all diagrams can be produced in SVG. For example, ditaa diagrams are only available in PNG format.
To get an ASCII Art representation of a diagram, encoded in UTF-8, use the following URL scheme: /plantuml/txt/ENCODED
Note that only sequence diagrams can be produced in ASCII Art.
To get the client image map
related to a previously generated PNG image, use the following URL scheme: /plantuml/map/ENCODED
The output is a list of
tags, each line matching a link present in the diagram description.
For example, the following diagram
participant Bob [[http://plantuml.com]]
Bob -> Alice : [[http://forum.plantuml.net]] hello
produces the following output
<map id="plantuml_map" name="plantuml_map">
<area shape="rect" id="id1" href="http://forum.plantuml.net" title="http://forum.plantuml.net" alt="" coords="38,50,199,65"/>
<area shape="rect" id="id2" href="http://plantuml.com" title="http://plantuml.com" alt="" coords="8,3,50,116"/>
Note that you need to include these
tags inside a
html tag to make the complete image map.
With the proxy service, the source description of the diagram can be fetched by the PlantUML Server from a remote document.
The proxy service uses the following URL scheme:
- RESOURCE is the complete URL of the document which contains the diagram description (with the
@endxxx tags), it could be a
.html or a
- INDEX is optional, it specifies the occurrence (starting at 0) of the diagram description that will be parsed when there are more than one diagram descriptions in the remote document. It defaults to zero.
- FORMAT is optional, it specifies the format to return. Supported values are:
txt. Default is
For example, try this link: http:www.plantuml.com/plantuml/proxy?src=https:raw.github.com/plantuml/plantuml-server/master/src/main/webapp/resource/test2diagrams.txt
Note that the address of the remote document is specified as a parameter, so it is not necessary to URL encode
To install PlantUML Server on your own JEE 5 web server, download the plantuml.war
file and copy it on the webapp
folder of your server.
PlantUML Server have been successfully tested on Tomcat 6 and 7 and Jetty 8 and 9.
PlantUML Server is open source, the code is available at https://github.com/plantuml/plantuml-server
(The main source is at https://github.com/plantuml/plantuml