tiarebalbi / java

Structurizr for Java

Structurizr for Java

This GitHub repository is (1) a client library for the Structurizr cloud service and on-premises installation and (2) a way to create a Structurizr workspace using Java code. Looking for the Structurizr DSL instead?

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, based upon the C4 model.

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/Lite, or other formats including PlantUML, Mermaid, DOT, and WebSequenceDiagrams via the structurizr-export library.

Table of contents

• Changelog
• Introduction
  • Getting started
  • Basic concepts (workspaces, models, views and documentation)
  • C4 model
  • Examples
  • Binaries
  • Building from source
  • FAQ
• Model
  • Creating your model
  • Implied relationships
• Views
  • Creating views
  • System Context diagram
  • Container diagram
  • Component diagram
  • Dynamic diagram
  • Deployment diagram
  • System Landscape diagram
  • Styling elements
  • Styling relationships
  • Filtered views
• Cloud service/on-premises installation
  • API client
  • Client-side encryption
• Related projects
  • structurizr-dsl: A text-based DSL for authoring Structurizr workspaces.
  • structurizr-export: Export model and views to external formats (e.g. PlantUML, Mermaid, etc).
  • structurizr-import: Import Markdown/AsciiDoc documentation/ADRs into a Structurizr workspace.