Visualise
Document
Record
Explore
The Structurizr DSL (as mentioned on the ThoughtWorks Tech Radar - Techniques - Diagrams as code)
allows you to create multiple diagrams based upon the C4 model, in multiple output formats, from a single DSL source file.
Some features are unavailable on this demo page - we recommend using the Structurizr CLI.
Structurizr CLI
|
VS Code extensions
|
Examples:
Getting Started
-
Amazon Web Services
-
Big Bank plc
|
Help
PlantUML definitions are available via the Structurizr CLI export command,
using the -format plantuml parameter.
C4-PlantUML definitions are available via the Structurizr CLI export command,
using the -format plantuml/c4plantuml parameter.
Mermaid definitions are available via the Structurizr CLI export command,
using the -format mermaid parameter. Your Mermaid configuration will need to include "securityLevel": "loose" to render this definition correctly.
WebSequenceDiagram definitions are available via the Structurizr CLI export command,
using the -format websequencediagrams parameter. Only dynamic views are supported.
DOT definitions are available via the Structurizr CLI export command,
using the -format dot parameter.
Ilograph definitions are available via the Structurizr CLI export command,
using the -format ilograph parameter. A single Ilograph export contains the model and all views.
resources:
- id: "1"
name: "Spring PetClinic"
subtitle: "[Software System]"
description: "Allows employees to view and manage information regarding the veterinarians, the clients, and their pets."
backgroundColor: "#ffffff"
color: "#000000"
children:
- id: "2"
name: "Web Application"
subtitle: "[Container: Java and Spring Boot]"
description: "Allows employees to view and manage information regarding the veterinarians, the clients, and their pets."
backgroundColor: "#ffffff"
color: "#000000"
- id: "3"
name: "Database"
subtitle: "[Container: Relational database schema]"
description: "Stores information regarding the veterinarians, the clients, and their pets."
backgroundColor: "#ffffff"
color: "#000000"
- id: "5"
name: "Amazon Web Services"
subtitle: "[Deployment Node]"
backgroundColor: "#ffffff"
color: "#232f3e"
children:
- id: "6"
name: "US-East-1"
subtitle: "[Deployment Node]"
backgroundColor: "#ffffff"
color: "#147eba"
children:
- id: "12"
name: "Amazon RDS"
subtitle: "[Deployment Node]"
backgroundColor: "#ffffff"
color: "#3b48cc"
children:
- id: "13"
name: "MySQL"
subtitle: "[Deployment Node]"
backgroundColor: "#ffffff"
color: "#000000"
children:
- id: "14"
name: "Database"
subtitle: "[Container: Relational database schema]"
description: "Stores information regarding the veterinarians, the clients, and their pets."
backgroundColor: "#ffffff"
color: "#000000"
- id: "9"
name: "Autoscaling group"
subtitle: "[Deployment Node]"
backgroundColor: "#ffffff"
color: "#cc2264"
children:
- id: "10"
name: "Amazon EC2"
subtitle: "[Deployment Node]"
backgroundColor: "#ffffff"
color: "#d86613"
children:
- id: "11"
name: "Web Application"
subtitle: "[Container: Java and Spring Boot]"
description: "Allows employees to view and manage information regarding the veterinarians, the clients, and their pets."
backgroundColor: "#ffffff"
color: "#000000"
- id: "7"
name: "Route 53"
subtitle: "[Infrastructure Node]"
backgroundColor: "#ffffff"
color: "#693cc5"
- id: "8"
name: "Elastic Load Balancer"
subtitle: "[Infrastructure Node]"
backgroundColor: "#ffffff"
color: "#693cc5"
perspectives:
- name: Static Structure
relations:
- from: "2"
to: "3"
label: "Reads from and writes to"
description: "JDBC/SSL"
- name: Deployment - Live
relations:
- from: "11"
to: "14"
label: "Reads from and writes to"
description: "JDBC/SSL"
- from: "7"
to: "8"
label: "Forwards requests to"
description: "HTTPS"
- from: "8"
to: "11"
label: "Forwards requests to"
description: "HTTPS"
The Structurizr DSL (as mentioned on the ThoughtWorks Tech Radar - Techniques - Diagrams as code) allows you to create multiple diagrams based upon the C4 model, in multiple output formats, from a single DSL source file.
This is the JSON version of your workspace.
{
"id" : 0,
"name" : "Amazon Web Services Example",
"description" : "An example AWS deployment architecture.",
"lastModifiedDate" : "2021-05-17T10:22:37Z",
"properties" : {
"structurizr.dsl" : "d29ya3NwYWNlICJBbWF6b24gV2ViIFNlcnZpY2VzIEV4YW1wbGUiICJBbiBleGFtcGxlIEFXUyBkZXBsb3ltZW50IGFyY2hpdGVjdHVyZS4iIHsKICAgIG1vZGVsIHsKICAgICAgICBzcHJpbmdQZXRDbGluaWMgPSBzb2Z0d2FyZXN5c3RlbSAiU3ByaW5nIFBldENsaW5pYyIgIkFsbG93cyBlbXBsb3llZXMgdG8gdmlldyBhbmQgbWFuYWdlIGluZm9ybWF0aW9uIHJlZ2FyZGluZyB0aGUgdmV0ZXJpbmFyaWFucywgdGhlIGNsaWVudHMsIGFuZCB0aGVpciBwZXRzLiIgIlNwcmluZyBCb290IEFwcGxpY2F0aW9uIiB7CiAgICAgICAgICAgIHdlYkFwcGxpY2F0aW9uID0gY29udGFpbmVyICJXZWIgQXBwbGljYXRpb24iICJBbGxvd3MgZW1wbG95ZWVzIHRvIHZpZXcgYW5kIG1hbmFnZSBpbmZvcm1hdGlvbiByZWdhcmRpbmcgdGhlIHZldGVyaW5hcmlhbnMsIHRoZSBjbGllbnRzLCBhbmQgdGhlaXIgcGV0cy4iICJKYXZhIGFuZCBTcHJpbmcgQm9vdCIKICAgICAgICAgICAgZGF0YWJhc2UgPSBjb250YWluZXIgIkRhdGFiYXNlIiAiU3RvcmVzIGluZm9ybWF0aW9uIHJlZ2FyZGluZyB0aGUgdmV0ZXJpbmFyaWFucywgdGhlIGNsaWVudHMsIGFuZCB0aGVpciBwZXRzLiIgIlJlbGF0aW9uYWwgZGF0YWJhc2Ugc2NoZW1hIiAiRGF0YWJhc2UiCiAgICAgICAgfQoKICAgICAgICB3ZWJBcHBsaWNhdGlvbiAtPiBkYXRhYmFzZSAiUmVhZHMgZnJvbSBhbmQgd3JpdGVzIHRvIiAiSkRCQy9TU0wiCgogICAgICAgIGRlcGxveW1lbnRFbnZpcm9ubWVudCAiTGl2ZSIgewogICAgICAgICAgICBkZXBsb3ltZW50Tm9kZSAiQW1hem9uIFdlYiBTZXJ2aWNlcyIgIiIgIiIgIkFtYXpvbiBXZWIgU2VydmljZXMgLSBDbG91ZCIgewogICAgICAgICAgICAgICAgZGVwbG95bWVudE5vZGUgIlVTLUVhc3QtMSIgIiIgIiIgIkFtYXpvbiBXZWIgU2VydmljZXMgLSBSZWdpb24iIHsKICAgICAgICAgICAgICAgICAgICByb3V0ZTUzID0gaW5mcmFzdHJ1Y3R1cmVOb2RlICJSb3V0ZSA1MyIgIiIgIiIgIkFtYXpvbiBXZWIgU2VydmljZXMgLSBSb3V0ZSA1MyIKICAgICAgICAgICAgICAgICAgICBlbGIgPSBpbmZyYXN0cnVjdHVyZU5vZGUgIkVsYXN0aWMgTG9hZCBCYWxhbmNlciIgIiIgIiIgIkFtYXpvbiBXZWIgU2VydmljZXMgLSBFbGFzdGljIExvYWQgQmFsYW5jaW5nIgoKICAgICAgICAgICAgICAgICAgICBkZXBsb3ltZW50Tm9kZSAiQXV0b3NjYWxpbmcgZ3JvdXAiICIiICIiICJBbWF6b24gV2ViIFNlcnZpY2VzIC0gQXV0byBTY2FsaW5nIiB7CiAgICAgICAgICAgICAgICAgICAgICAgIGRlcGxveW1lbnROb2RlICJBbWF6b24gRUMyIiAiIiAiIiAiQW1hem9uIFdlYiBTZXJ2aWNlcyAtIEVDMiIgewogICAgICAgICAgICAgICAgICAgICAgICAgICAgd2ViQXBwbGljYXRpb25JbnN0YW5jZSA9IGNvbnRhaW5lckluc3RhbmNlIHdlYkFwcGxpY2F0aW9uCiAgICAgICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgICAgICB9CgogICAgICAgICAgICAgICAgICAgIGRlcGxveW1lbnROb2RlICJBbWF6b24gUkRTIiAiIiAiIiAiQW1hem9uIFdlYiBTZXJ2aWNlcyAtIFJEUyIgewogICAgICAgICAgICAgICAgICAgICAgICBkZXBsb3ltZW50Tm9kZSAiTXlTUUwiICIiICIiICJBbWF6b24gV2ViIFNlcnZpY2VzIC0gUkRTX015U1FMX2luc3RhbmNlIiB7CiAgICAgICAgICAgICAgICAgICAgICAgICAgICBjb250YWluZXJJbnN0YW5jZSBkYXRhYmFzZQogICAgICAgICAgICAgICAgICAgICAgICB9CiAgICAgICAgICAgICAgICAgICAgfQoKICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgfQoKICAgICAgICAgICAgcm91dGU1MyAtPiBlbGIgIkZvcndhcmRzIHJlcXVlc3RzIHRvIiAiSFRUUFMiCiAgICAgICAgICAgIGVsYiAtPiB3ZWJBcHBsaWNhdGlvbkluc3RhbmNlICJGb3J3YXJkcyByZXF1ZXN0cyB0byIgIkhUVFBTIgogICAgICAgIH0KICAgIH0KICAgICAgICAgCiAgICB2aWV3cyB7CiAgICAgICAgZGVwbG95bWVudCBzcHJpbmdQZXRDbGluaWMgIkxpdmUiICJBbWF6b25XZWJTZXJ2aWNlc0RlcGxveW1lbnQiIHsKICAgICAgICAgICAgaW5jbHVkZSAqCiAgICAgICAgICAgIGF1dG9sYXlvdXQgbHIKICAgICAgICB9CgogICAgICAgIHN0eWxlcyB7CiAgICAgICAgICAgIGVsZW1lbnQgIkVsZW1lbnQiIHsKICAgICAgICAgICAgICAgIHNoYXBlIHJvdW5kZWRib3gKICAgICAgICAgICAgICAgIGJhY2tncm91bmQgI2ZmZmZmZgogICAgICAgICAgICB9CiAgICAgICAgICAgIGVsZW1lbnQgIkRhdGFiYXNlIiB7CiAgICAgICAgICAgICAgICBzaGFwZSBjeWxpbmRlcgogICAgICAgICAgICB9CiAgICAgICAgICAgIGVsZW1lbnQgIkluZnJhc3RydWN0dXJlIE5vZGUiIHsKICAgICAgICAgICAgICAgIHNoYXBlIHJvdW5kZWRib3gKICAgICAgICAgICAgfQogICAgICAgIH0KCiAgICAgICAgdGhlbWVzIGh0dHBzOi8vc3RhdGljLnN0cnVjdHVyaXpyLmNvbS90aGVtZXMvYW1hem9uLXdlYi1zZXJ2aWNlcy0yMDIwLjA0LjMwL3RoZW1lLmpzb24KICAgIH0KfQo="
},
"configuration" : { },
"model" : {
"softwareSystems" : [ {
"id" : "1",
"tags" : "Element,Software System,Spring Boot Application",
"name" : "Spring PetClinic",
"description" : "Allows employees to view and manage information regarding the veterinarians, the clients, and their pets.",
"location" : "Unspecified",
"containers" : [ {
"id" : "3",
"tags" : "Element,Container,Database",
"name" : "Database",
"description" : "Stores information regarding the veterinarians, the clients, and their pets.",
"technology" : "Relational database schema"
}, {
"id" : "2",
"tags" : "Element,Container",
"name" : "Web Application",
"description" : "Allows employees to view and manage information regarding the veterinarians, the clients, and their pets.",
"relationships" : [ {
"id" : "4",
"tags" : "Relationship",
"sourceId" : "2",
"destinationId" : "3",
"description" : "Reads from and writes to",
"technology" : "JDBC/SSL"
} ],
"technology" : "Java and Spring Boot"
} ]
} ],
"deploymentNodes" : [ {
"id" : "5",
"tags" : "Element,Deployment Node,Amazon Web Services - Cloud",
"name" : "Amazon Web Services",
"environment" : "Live",
"instances" : 1,
"children" : [ {
"id" : "6",
"tags" : "Element,Deployment Node,Amazon Web Services - Region",
"name" : "US-East-1",
"environment" : "Live",
"instances" : 1,
"children" : [ {
"id" : "12",
"tags" : "Element,Deployment Node,Amazon Web Services - RDS",
"name" : "Amazon RDS",
"environment" : "Live",
"instances" : 1,
"children" : [ {
"id" : "13",
"tags" : "Element,Deployment Node,Amazon Web Services - RDS_MySQL_instance",
"name" : "MySQL",
"environment" : "Live",
"instances" : 1,
"containerInstances" : [ {
"id" : "14",
"tags" : "Container Instance",
"environment" : "Live",
"deploymentGroup" : "Default",
"instanceId" : 1,
"containerId" : "3"
} ]
} ]
}, {
"id" : "9",
"tags" : "Element,Deployment Node,Amazon Web Services - Auto Scaling",
"name" : "Autoscaling group",
"environment" : "Live",
"instances" : 1,
"children" : [ {
"id" : "10",
"tags" : "Element,Deployment Node,Amazon Web Services - EC2",
"name" : "Amazon EC2",
"environment" : "Live",
"instances" : 1,
"containerInstances" : [ {
"id" : "11",
"tags" : "Container Instance",
"relationships" : [ {
"id" : "15",
"sourceId" : "11",
"destinationId" : "14",
"description" : "Reads from and writes to",
"technology" : "JDBC/SSL",
"linkedRelationshipId" : "4"
} ],
"environment" : "Live",
"deploymentGroup" : "Default",
"instanceId" : 1,
"containerId" : "2"
} ]
} ]
} ],
"infrastructureNodes" : [ {
"id" : "7",
"tags" : "Element,Infrastructure Node,Amazon Web Services - Route 53",
"name" : "Route 53",
"relationships" : [ {
"id" : "16",
"tags" : "Relationship",
"sourceId" : "7",
"destinationId" : "8",
"description" : "Forwards requests to",
"technology" : "HTTPS"
} ],
"environment" : "Live"
}, {
"id" : "8",
"tags" : "Element,Infrastructure Node,Amazon Web Services - Elastic Load Balancing",
"name" : "Elastic Load Balancer",
"relationships" : [ {
"id" : "17",
"tags" : "Relationship",
"sourceId" : "8",
"destinationId" : "11",
"description" : "Forwards requests to",
"technology" : "HTTPS"
} ],
"environment" : "Live"
} ]
} ]
} ]
},
"documentation" : { },
"views" : {
"deploymentViews" : [ {
"softwareSystemId" : "1",
"key" : "AmazonWebServicesDeployment",
"automaticLayout" : {
"implementation" : "Graphviz",
"rankDirection" : "LeftRight",
"rankSeparation" : 300,
"nodeSeparation" : 300,
"edgeSeparation" : 0,
"vertices" : false
},
"environment" : "Live",
"elements" : [ {
"id" : "11",
"x" : 0,
"y" : 0
}, {
"id" : "12",
"x" : 0,
"y" : 0
}, {
"id" : "13",
"x" : 0,
"y" : 0
}, {
"id" : "14",
"x" : 0,
"y" : 0
}, {
"id" : "5",
"x" : 0,
"y" : 0
}, {
"id" : "6",
"x" : 0,
"y" : 0
}, {
"id" : "7",
"x" : 0,
"y" : 0
}, {
"id" : "8",
"x" : 0,
"y" : 0
}, {
"id" : "9",
"x" : 0,
"y" : 0
}, {
"id" : "10",
"x" : 0,
"y" : 0
} ],
"relationships" : [ {
"id" : "17"
}, {
"id" : "16"
}, {
"id" : "15"
} ]
} ],
"configuration" : {
"branding" : { },
"styles" : {
"elements" : [ {
"tag" : "Element",
"background" : "#ffffff",
"shape" : "RoundedBox"
}, {
"tag" : "Database",
"shape" : "Cylinder"
}, {
"tag" : "Infrastructure Node",
"shape" : "RoundedBox"
} ]
},
"themes" : [ "https://static.structurizr.com/themes/amazon-web-services-2020.04.30/theme.json" ],
"terminology" : { }
}
}
}
And here is an export of the styles defined in your workspace, as a theme.
{
"name" : "Amazon Web Services Example",
"description" : "An example AWS deployment architecture.",
"elements" : [ {
"tag" : "Element",
"background" : "#ffffff",
"shape" : "RoundedBox"
}, {
"tag" : "Database",
"shape" : "Cylinder"
}, {
"tag" : "Infrastructure Node",
"shape" : "RoundedBox"
} ]
}