JoinedWorkz
Docs1.3.80

Appearance

Base facility ​

The common-base facility bundles everything required to model and generate platform‑independent artefacts in JoinedWorkz. It provides the foundational concepts and cartridges used by all higher‑level platforms.

It includes:

  • Simple base types (String, Integer, Date, Timestamp, Boolean, Id, …)
  • Base REST method types (raw HTTP and opinionated REST helpers)
  • OpenAPI cartridge
  • Diagram cartridge (interactive HTML diagrams)
  • CMN models for types and REST modelling

Your application only needs to add the facility as a Maven dependency.
The JoinedWorkz generator plugin automatically discovers its profiles, CMN models and cartridges.

1. Maven dependency ​

xml
<dependency>
    <groupId>org.joinedworkz.facilities</groupId>
    <artifactId>common-base</artifactId>
    <version>${joinedworkz.version}</version>
    <scope>provided</scope>
</dependency>

2. Activating the Base platform in CMN models ​

cmn
import org.joinedworkz.facilities.common.base
import org.joinedworkz.facilities.common.base.api

platform Base

3. What the base facility provides ​

  • Base types
  • Base REST method types (create, read, update, query, raw methods; see the documented 1.3.80 delete name conflict)
  • OpenAPI generation (YAML + HTML)
  • Diagram generation (components, APIs, types, processes)

See related pages:

  • Target artefacts
  • Base profile & modeling
  • Example (Quickstart)