Documentation

English

Deutsch
Français
Español
Italiano
Türkçe

English

Deutsch
Français
Español
Italiano
Türkçe

Appearance

Workspace ​

The workspace is where domain, API, and runtime decisions stay connected in one operational flow. It is the central environment where you build, configure, validate, and iterate on your mock API project.

This page provides an overview of the workspace areas. Each area has its own detailed guide linked below.

Workspace Areas ​

The workspace is organized into distinct areas, each focused on a specific part of the modeling and API design workflow. Changes in one area are immediately reflected across the others.

Modelling Board ​

The visual canvas where you create entity table cards, position them spatially, and connect them with relation lines. The board is the starting point for all modelling work — drag to connect entities, zoom and pan to navigate large domains, and use the minimap for orientation.

Tables & Attributes ​

The configuration layer for each entity. Define table properties (name, description, icon), add attributes with types and flags (sortable, filterable, searchable, required), and select data sources for each field. Attribute flags directly determine how the API layer exposes your data.

Relations ​

Connect entities to define how data flows between them. Choose cardinality (1:1, 1:n, m:n), set direction and ownership, and specify linking columns. Relations determine how the runtime engine resolves nested GraphQL queries.

Data Sources & Mapping ​

Configure where each attribute's data comes from. Three mapping types are available: OFF_FIELD (real-world datasets), FAKE (Faker synthetic data), and CONST (fixed values). The mapping type determines what values the field returns at runtime.

Views ​

Define how a table's data is presented to API consumers. Configure column visibility, pagination defaults, sort behavior, and detail relations. Views bridge the gap between the raw domain model and the consumer-facing API response shape.

API Design ​

Control how your domain model is exposed as a GraphQL API. Set query names, enable or disable operations per entity, configure pagination limits, and shape the consumer-facing API contract.

Preview & Hints ​

The feedback loop that keeps your model honest. Open preview to test queries against your mapped data and receive actionable hints about unmapped attributes, configuration mismatches, and relation warnings. Preview should be part of every modelling iteration.

Modelling Runtime Preview ​

A dedicated panel that combines view configuration, live data preview, and relation detail into one place — accessible directly from the modelling board via the play button on any table card.

When working in one area, links to related contexts are available inline. For example:

  • From a table detail view, jump to the runtime preview to test queries.
  • From the runtime preview, jump back to the table editor to fix a field issue.
  • From the API design view, jump to the modelling board to review domain structure.

This navigation model keeps you in flow — you never need to go "back to the dashboard" to switch context.

Project Context ​

Each project has a unique slug that determines its API endpoint URL:

POST /mock/{slug}/graphql

The slug is auto-generated from your project name but can be customized. Keep slugs short, lowercase, and hyphenated (e.g., customer-portal, ecommerce-demo).

Screenshot ws-01-project-switcherScreenshot ws-01-project-switcher
ws-01-project-switcherMissing

Project context bar and view switching.