Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Using PlantUML and Structurizr Together

DZone's Guide to

Using PlantUML and Structurizr Together

Creating a PlantUML exporter for Structurizr allows you to create a model of your software system and have the PlantUML diagrams be consistent with that model.

· Integration Zone
Free Resource

Share, secure, distribute, control, and monetize your APIs with the platform built with performance, time-to-value, and growth in mind. Free 90-day trial of 3Scale by Red Hat

Despite the seemingly high unpopularity of UML these days, it continues to surprise me just how many software teams tell me that they use PlantUML. If you've not seen it, PlantUML is basically a tool that allows you to create UML diagrams using text. While the use of text is very developer-friendly, PlantUML isn't a modeling tool. By this, I mean you're not creating a single consistent model of a software system and creating different UML diagrams (views) based on that model. Instead, you're simply creating a single UML diagram at a time, which means that you need to take responsibility for the consistent naming of elements across diagrams.

Some teams that I've worked with have solved this problem by writing small applications that generate the PlantUML diagram definitions based upon a model of their software systems, but these tend to be bespoke solutions that are never shared outside of the team that created them. Something I've done recently is creating a PlantUML exporter for Structurizr. Using PlantUML in conjunction with the Structurizr open-source library allows you to create a model of your software system and have the resulting PlantUML diagrams be consistent with that model. If you use the Structurizr's component finder, which uses reflection to identify components in your codebase, you can create component level UML diagrams automatically.

A PlantUML component diagram

Even if you're not interested in using my Structurizr software as a service, I would encourage you to at least use the open-source library for creating a model of your software system and extract components from your code where possible. Once you have a model, you can visualize that model in a number of different ways.

Explore the core elements of owning an API strategy and best practices for effective API programs. Download the API Owner's Manual, brought to you by 3Scale by Red Hat

Topics:
plantuml ,structurizr ,integration

Published at DZone with permission of Simon Brown, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

THE DZONE NEWSLETTER

Dev Resources & Solutions Straight to Your Inbox

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.

X

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}