61
Watch
814
Star
230
Fork
85
Issue

Structurizr for Java

structurizr
structurizr
pushedAt 1 day ago

structurizr/java

Structurizr

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.

Views can be exported and visualised in many ways; e.g. PlantUML, Structurizr and Graphviz

Table of contents

Build Status