JarCasting
Structurizr for Java
This GitHub repository is an official client library for the Structurizr cloud service and on-premises installation, both of which are web-based publishing platforms for software architecture models based upon the C4 model. The component finder, adr-tools importer, and alternative diagram export formats (e.g. PlantUML) can be found at Structurizr for Java extensions.
A quick example
As an example, the following Java code can be used to create a software architecture model and an associated view that describes a user using a software system.
public static void main(String[] args) throws Exception {
Workspace workspace = new Workspace("Getting Started", "This is a model of my software system.");
Model model = workspace.getModel();
Person user = model.addPerson("User", "A user of my software system.");
SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system.");
user.uses(softwareSystem, "Uses");
ViewSet views = workspace.getViews();
SystemContextView contextView = views.createSystemContextView(softwareSystem, "SystemContext", "An example of a System Context diagram.");
contextView.addAllSoftwareSystems();
contextView.addAllPeople();
}
The view can then be exported to be visualised using the Structurizr cloud service/on-premises installation, or other formats including PlantUML and WebSequenceDiagrams via the Structurizr for Java extensions.
Table of contents
- Introduction
- Getting started
- About Structurizr and how it compares to other tooling
- Why use code?
- Basic concepts (workspaces, models, views and documentation)
- C4 model
- Examples
- Binaries
- Building from source
- API client
- Usage patterns
- FAQ
- Model
- Views
- Documentation
- Other
- Related projects
- java-quickstart: A simple starting point for using Structurizr for Java
- java-extensions: A collection of Structurizr for Java extensions; including the ability to extract software architecture information from code, export views to PlantUML, etc.
- arch-as-code: A tool to store software architecture diagrams/documentation as YAML, and publish it to Structurizr.
- structurizr-kotlin: An extension for Structurizr that lets you create your models in a fluent way.
- structurizr-spring-boot: A way to apply dependency management to help modularise Structurizr code.
- structurizr-groovy: An initial version of a Groovy wrapper around Structurizr for Java.
- structurizr-dotnet: Structurizr for .NET
- changelog
