Base example (Quickstart)

This example demonstrates the common-base facility in action:

• OpenAPI YAML
• OpenAPI HTML
• component diagrams
• API diagrams
• datatype diagrams

Project:

👉 https://gitlab.com/joinedworkz/joinedworkz-quickstart

---

1. Model

type Greeting {
    message*: String
}

resource /hello as Greeting {
    create createHello()
    read readHello()
}

---

2. Generated artefacts

• openapi.yaml
• openapi.html
• diagram/components.html
• diagram/types.html
• diagram/api.html

Screenshots in the documentation show examples.

---

3. How to generate

mvn clean install

Open the generated HTML files in your browser.

---

4. Next steps

• add more resources
• add pseudocode for process/call flow diagrams
• use with other facilities (Java, SpringBoot)