JoinedWorkz

Appearance

JoinedWorkz Docs

Canonical models, platform profiles and generators.

Get started
Model a REST API
Spring Boot CRUD example

Canonical modeling with CMN

Describe your domain, APIs, components and applications once in the Canonical Model Notation (.cmn) and let platforms interpret the model.

Facilities and platforms

Use ready-made facilities like Base, Java and SpringBoot or define your own profiles, cartridges and outlets to fit your stack.

Studio and Maven integration

Edit models with JoinedWorkz Studio (syntax highlighting, validation, generation) and run the JoinedWorkz Maven plugin in your build.

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.
    → Get Started → Quickstart

  2. Model a REST API step by step
    Learn the basic CMN concepts (types, resources, method types) by modelling a small REST API.
    → How-to Guides → Model a REST API step by step

  3. Build a CRUD API with Spring Boot facility
    See how the SpringBoot platform, entity CRUD helpers and handlers work together in a runnable Spring Boot example.
    → How-to Guides → Build a CRUD API with Spring Boot facility

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

Documentation status

The JoinedWorkz documentation is actively being updated.

  • Some sections are already complete and reflect the current release.
  • Other sections are still work in progress and will be extended.

If something important is missing or unclear, please refer to the examples on GitLab (e.g. joinedworkz-quickstart, example-spring-boot) or contact the maintainer listed on the JoinedWorkz website.