JoinedWorkz

Appearance

Target artefacts (OpenAPI & diagrams) ​

The common-base facility generates platform‑neutral artefacts directly from your CMN models — fully independent of programming languages or frameworks.

1. OpenAPI artefacts ​

✓ OpenAPI YAML ​

Generated from:

  • resource definitions
  • methodtypes
  • parameters
  • types & enums

✓ OpenAPI HTML ​

Interactive Swagger-style viewer
(embedded YAML).

These artefacts appear in the OpenAPI outlets and can be opened directly in a browser.

2. Diagram artefacts ​

The Diagram cartridge generates multiple HTML diagrams:

2.1 Component overview ​

Shows components of the application + dependencies (incl. pseudocode-based call edges).

Component overview diagram

2.2 Component + provided API diagram ​

Shows each component and its REST endpoints.
Each endpoint links to its corresponding OpenAPI HTML.

OpenAPI HTML viewer diagram

2.3 Datatype diagrams ​

Show complex types, attributes, relations, inheritance.

Minimal type diagram

2.4 Process/sequence diagrams ​

Generated if pseudocode in provided endpoint of component is modeled.

Sequence diagram

3. Outlets ​

Typical output locations:

  • /generated-resources/openapi/*.yaml
  • /generated-resources/openapi/*.html
  • /generated-resources/diagram/*.html

Customisable via joinedworkz.properties.

4. Example ​

See the Quickstart example to view all artefacts in practice.