Structurizr for Java


License

License

GroupId

GroupId

com.structurizr
ArtifactId

ArtifactId

structurizr-examples
Last Version

Last Version

1.0.0-RC6
Release Date

Release Date

Type

Type

jar
Description

Description

Structurizr for Java
Structurizr for Java
Project URL

Project URL

https://github.com/structurizr/java
Source Code Management

Source Code Management

https://github.com/structurizr/java

Download structurizr-examples

How to add to project

<!-- https://jarcasting.com/artifacts/com.structurizr/structurizr-examples/ -->
<dependency>
    <groupId>com.structurizr</groupId>
    <artifactId>structurizr-examples</artifactId>
    <version>1.0.0-RC6</version>
</dependency>
// https://jarcasting.com/artifacts/com.structurizr/structurizr-examples/
implementation 'com.structurizr:structurizr-examples:1.0.0-RC6'
// https://jarcasting.com/artifacts/com.structurizr/structurizr-examples/
implementation ("com.structurizr:structurizr-examples:1.0.0-RC6")
'com.structurizr:structurizr-examples:jar:1.0.0-RC6'
<dependency org="com.structurizr" name="structurizr-examples" rev="1.0.0-RC6">
  <artifact name="structurizr-examples" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.structurizr', module='structurizr-examples', version='1.0.0-RC6')
)
libraryDependencies += "com.structurizr" % "structurizr-examples" % "1.0.0-RC6"
[com.structurizr/structurizr-examples "1.0.0-RC6"]

Dependencies

compile (8)

Group / Artifact Type Version
com.google.code.findbugs : jsr305 jar 3.0.2
com.structurizr : structurizr-annotations jar 1.0.0-RC6
com.structurizr : structurizr-client jar 1.0.0-RC6
com.structurizr : structurizr-dot jar 1.0.0-RC6
com.structurizr : structurizr-plantuml jar 1.0.0-RC6
com.structurizr : structurizr-spring jar 1.0.0-RC6
org.slf4j : slf4j-api jar 1.7.21
org.slf4j : slf4j-simple jar 1.7.21

Project Modules

There are no modules declared in this project.

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. This repository is supported by Structurizr Limited, as a part of the Structurizr service.

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

com.structurizr

Structurizr client libraries, tooling and integrations

Visualise, document and explore your software architecture.

Versions

Version
1.0.0-RC6
1.0.0-RC5