JoinedWorkz
Docs1.3.81

Appearance

JoinedWorkz Docs

Canonical models, platform profiles and generators.

Get started
Configure JoinedWorkz
Troubleshooting

Start

Generate a small Base project, inspect its OpenAPI and diagram output, and learn the complete model-to-build flow.

Concepts

Understand canonical models, profiles, platforms, facilities, cartridges, outlets and generated-output ownership.

Build & Configuration

Configure joinedworkz.properties, the Maven plugin, multi-module routing and build diagnostics.

Modeling

Learn CMN and the Profile DSL, then use the detailed syntax and modeling references.

Facilities

Choose the stable Base, Java and SpringBoot facilities or evaluate the experimental Quasar facility.

Examples

Follow focused end-to-end guides and run the release-pinned public example projects.

Extending JoinedWorkz

Package a custom Profile, Cartridge and generator as a reusable Maven Facility.

AI-assisted development

Supply AI tools with explicit framework, project, task and source context while preserving ownership boundaries.

Release & Support

Align JoinedWorkz versions, follow upgrade guidance and choose the appropriate support channel.

Documentation baseline

Base, Java and SpringBoot are stable; Quasar is experimental. See Documentation versions to select the documentation matching your JoinedWorkz release, and see Releases, compatibility and support before upgrading or reporting a problem.

Developer shortcuts ​

Where to start

If you are new to JoinedWorkz, a good path is:

  1. Quickstart Create a small project, add the JoinedWorkz Maven plugin and generate your first OpenAPI spec.

  2. Model a REST API step by step Learn the basic CMN concepts (types, resources, method types) by modeling a small REST API.

  3. Build a CRUD API with SpringBoot See how the SpringBoot platform generates the persistence and HTTP boundary for entity CRUD in the executable Spring Boot example.

  4. Example projects Explore the public repositories and run the examples locally.