Last active
June 11, 2020 20:59
-
-
Save simonbrowndotje/7d1bab20aefef4586f9fdda6c28c1df1 to your computer and use it in GitHub Desktop.
An example of the Structurizr modelling DSL
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
workspace "Big Bank plc" "This is an example workspace to illustrate the key features of Structurizr, via the DSL, based around a fictional online banking system." { | |
model { | |
customer = person "Personal Banking Customer" "A customer of the bank, with personal bank accounts." | |
enterprise "Big Bank plc" { | |
supportStaff = person "Customer Service Staff" "Customer service staff within the bank." "Bank Staff" | |
backoffice = person "Back Office Staff" "Administration and support staff within the bank." | |
mainframe = softwaresystem "Mainframe Banking System" "Stores all of the core banking information about customers, accounts, transactions, etc." "Existing System" | |
email = softwaresystem "E-mail System" "The internal Microsoft Exchange e-mail system" "Existing System" | |
atm = softwaresystem "ATM" "Allows customers to withdraw cash." "Existing System" | |
internetBankingSystem = softwaresystem "Internet Banking System" "Allows customers to view information about their bank accounts, and make payments." { | |
singlePageApplication = container "Single-Page Application" "Provides all of the Internet banking functionality to customers via their web browser." "JavaScript and Angular" "Web Browser" | |
mobileApp = container "Mobile App" "Provides a limited subset of the Internet banking functionality to customers via their mobile device." "Xamarin" "Mobile App" | |
webApplication = container "Web Application" "Delivers the static content and the Internet banking single page application." "Java and Spring MVC" | |
apiApplication = container "API Application" "Provides Internet banking functionality via a JSON/HTTPS API." "Java and Spring MVC" { | |
signinController = component "Sign In Controller" "Allows users to sign in to the Internet Banking System." "Spring MVC Rest Controller" | |
accountsSummaryController = component "Accounts Summary Controller" "Provides customers with a summary of their bank accounts." "Spring MVC Rest Controller" | |
resetPasswordController = component "Reset Password Controller" "Allows users to reset their passwords with a single use URL." "Spring MVC Rest Controller" | |
securityComponent = component "Security Component" "Provides functionality related to signing in, changing passwords, etc." "Spring Bean" | |
mainframeBankingSystemFacade = component "Mainframe Banking System Facade" "A facade onto the mainframe banking system." "Spring Bean" | |
emailComponent = component "E-mail Component" "Sends e-mails to users." "Spring Bean" | |
} | |
database = container "Database" "Stores user registration information, hashed authentication credentials, access logs, etc." "Oracle Database Schema" "Database" | |
} | |
} | |
# relationships between people and software systems | |
customer -> internetBankingSystem "Views account balances, and makes payments using" | |
internetBankingSystem -> mainframe "Gets account information from, and makes payments using" | |
internetBankingSystem -> email "Sends e-mail using" | |
email -> customer "Sends e-mails to" | |
customer -> supportStaff "Asks questions to" "Telephone" | |
supportStaff -> mainframe "Uses" | |
customer -> atm "Withdraws cash using" | |
atm -> mainframe "Uses" | |
backoffice -> mainframe "Uses" | |
# relationships to/from containers | |
customer -> webApplication "Visits bigbank.com/ib using" "HTTPS" | |
customer -> singlePageApplication "Views account balances, and makes payments using" | |
customer -> mobileApp "Views account balances, and makes payments using" | |
webApplication -> singlePageApplication "Delivers to the customer's web browser" | |
# relationships to/from components | |
singlePageApplication -> signinController "Makes API calls to" "JSON/HTTPS" | |
singlePageApplication -> accountsSummaryController "Makes API calls to" "JSON/HTTPS" | |
singlePageApplication -> resetPasswordController "Makes API calls to" "JSON/HTTPS" | |
mobileApp -> signinController "Makes API calls to" "JSON/HTTPS" | |
mobileApp -> accountsSummaryController "Makes API calls to" "JSON/HTTPS" | |
mobileApp -> resetPasswordController "Makes API calls to" "JSON/HTTPS" | |
signinController -> securityComponent "Uses" | |
accountsSummaryController -> mainframeBankingSystemFacade "Uses" | |
resetPasswordController -> securityComponent "Uses" | |
resetPasswordController -> emailComponent "Uses" | |
securityComponent -> database "Reads from and writes to" "JDBC" | |
mainframeBankingSystemFacade -> mainframe "Makes API calls to" "XML/HTTPS" | |
emailComponent -> email "Sends e-mail using" | |
} | |
views { | |
systemlandscape "SystemLandscape" { | |
elements * | |
} | |
systemcontext internetBankingSystem "SystemContext" { | |
elements * | |
} | |
container internetBankingSystem "Containers" { | |
elements * | |
} | |
component apiApplication "Components" { | |
elements * | |
} | |
themes https://structurizr.com/share/36141/theme | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment