Quickstart

Installation

Structurizr DSL is a domain-specific language implemented in TypeScript for describing software architecture. It provides a fluent and type-safe API to define your architecture models and views.

Install the package via npm:

npm install @restruct/structurizr-dsl

Define the workspace

The DSL uses a callback-based fluent API to build a workspace.

import { workspace } from "@restruct/structurizr-dsl";

export default workspace(
    "Architecture",
    "A short description of my architecture",
    (_) => {
        _.model((_) => {
            const user = _.person("User", "A user of my software system");
            const system = _.softwareSystem(
                "Software System",
                "My software system"
            );
            _.uses(user.identifier, system.identifier, "Uses");
        });

        _.views((_) => {
            _.systemLandscapeView("SystemLandscape", "A system landscape view");
        });
    }
);