Here is a quick overview of how to get started with Structurizr for Java so that you can create a software architecture model as code. You can find the code here. For more examples, please see structurizr-examples.

If you want a quick start, simply clone the Structurizr for Java starter project.

1. Dependencies

The Structurizr for Java binaries are hosted on Bintray and the JCenter repository. The dependencies for use with Maven, Ivy, Gradle, etc are as follows.

Please note that you will need to add "http://jcenter.bintray.com" as an additional repository to your build configuration.

2. Create a model

The first step is to create a workspace in which the software architecture model will reside.

Workspace workspace = new Workspace("My model", "This is a model of my software system.");
Model model = workspace.getModel();

Now let's add some elements to the model.

Person user = model.addPerson("User", "A user of my software system.");
SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system.");
user.uses(softwareSystem, "Uses");

3. Create some views

With the model created, we need to create some views with which to visualise it.

ViewSet viewSet = workspace.getViews();
SystemContextView contextView = viewSet.createSystemContextView(softwareSystem, "context", "A simple example of a System Context diagram.");
contextView.addAllSoftwareSystems();
contextView.addAllPeople();

4. Add some colour

Elements and relationships can be styled by specifying colours, sizes and shapes.

Styles styles = viewSet.getConfiguration().getStyles();
styles.addElementStyle(Tags.SOFTWARE_SYSTEM).background("#1168bd").color("#ffffff");
styles.addElementStyle(Tags.PERSON).background("#08427b").color("#ffffff").shape(Shape.Person);

5. Upload to Structurizr

structurizr.com provides an API to get and put workspaces directly from/to your Structurizr account as follows.

StructurizrClient structurizrClient = new StructurizrClient("key", "secret");
structurizrClient.putWorkspace(1234, workspace);

In order to upload your model to Structurizr using the web API, you'll need to sign up to get your own API key and secret. See Workspaces for information about finding your workspace ID, API key and secret.

The result is a diagram like this (once you've dragged the boxes around).