marcflohrer/structurizrtomarkdown

Converts structurizr workspace.json into a interface description list listing the properties of the interfaces in markdown list.

structurizr 2 markdown

Converts structurizr workspace.json into a interface description list listing the properties of the interfaces in left aligned markdown list.

Prerequisites

You need a workspace.json file from structurizr that has relationships between interfaces and components with properties on the interfaces. The properties for all interfaces need to have the same keys

Feature

It takes a workspace.json as input that has to contain properties on the relationships like this:

workspace {
    model {
        user = person "User" "A user of my software system."
        softwareSystem1 = softwareSystem "Software System" "My software system." {
            container1 = container "Internal Container" {
                component1 = component "component" {
                    perspectives {
                        "view" "dsgvo"
                    }
                }
            }
        }

        user -> softwareSystem1 "Uses" {
            properties {
                "Encryption" "Yes, TLS 1.2"
                "Data classifiation" "Personal data"
                "Purpose" "User management"
            }
        }
    }

The above shows the corresponding workspace.dsl but the json file is derived from it.

The output is a markdown file named workspace.md that looks like this:

| Encryption | Data classifiation | Purpose |
| :--- | :--- | :--- |
| Yes, TLS 1.2 | Personal data | User management |

Usage

From sources

1. Clone the repository
2. cd into the repository
3. Run dotnet build
4. Run dotnet interface-description-list.dll -w <path to workspace.json>

From docker image

1. Run chmod +x run.sh && ./run.sh "<path to directory that contains workspace.json>

Example

chmod +x run.sh && ./run.sh /Users/username/Documents/structurizr/

Output file

The output file is the same as the input file with the extension changed to .md