Modelle, Enums und Eigenschaften

Die Modelle beschreiben die Daten Ihrer API. Ein Modell trägt typisierte Eigenschaften, und diese Eigenschaften können andere Modelle oder Enums referenzieren.

Die Enums

Ein Enum ist eine geschlossene Wertemenge (zum Beispiel ein Status draft / published / archived). Ein Design verwaltet sie auf zwei Arten:

• Benannte Enums — wiederverwendbar, erstrangig. Verwenden Sie im Bereich Enums Enum hinzufügen, geben Sie ihm einen Namen und eine Beschreibung und dann Wert hinzufügen für jeden Eintrag. Eine Eigenschaft (oder ein Routenparameter) referenziert ihn anschließend über seinen Typ.
• Inline-Enums — eine anonyme Menge, die direkt auf einer Eigenschaft deklariert wird. Auf einer Eigenschaft string / integer / number ermöglicht Ihnen ein Chip-Editor Enum-Werte, die erlaubten Werte direkt vor Ort aufzulisten, ohne einen benannten Typ zu erstellen.

Wenn ein Inline-Enum es wert ist, geteilt zu werden, stuft ihn In einen benannten Enum extrahieren hoch: Es erstellt den benannten Enum (wobei ein bestehender Enum mit denselben Werten wiederverwendet wird, um Duplikate zu vermeiden) und schreibt die Eigenschaft so um, dass sie ihn referenziert. Auch die Routenparameter tragen Inline-Enums und dieselbe Aktion Extrahieren — siehe Routen & CRUD.

Die Eigenschaften eines Modells

Wählen Sie im Bereich Modelle ein Modell aus: seine Eigenschaften werden in einer Tabelle angezeigt (Eigenschaft, Typ, Flags, Beispiel). Verwenden Sie Eigenschaft hinzufügen, um eine zu erstellen.

Eine Eigenschaft kann von folgendem Typ sein:

• ein Primitiv: string, integer, number, boolean;
• ein Array (array<…>) oder eine Map (map<…>) eines anderen Typs;
• eine Referenz auf ein anderes Modell;
• eine Referenz auf ein Enum.

Für einen string können Sie ein Format angeben: email, uuid, date, date-time, uri, hostname, ipv4, password oder byte.

Über den Typ hinaus akzeptiert eine Eigenschaft zahlreiche Felder: Beschreibung, Beispiel, Standardwert, Minimum / Maximum, Mindestlänge / Maximallänge, Muster (Regex), Verwerfungsmeldung und — für Referenzen — ein Verhalten On delete.

Die Flags

Flags qualifizieren die Eigenschaft und werden als Badges angezeigt: erforderlich, nullable, eindeutig, unveränderlich, searchable (durchsuchbar — siehe Routen & CRUD), verworfen, schreibgeschützt, nur schreibbar und PII (personenbezogene Daten).

Identität und Vererbung

Jedes Modell hat eigene Einstellungen:

• Identität — die identifizierende Eigenschaft und ihre Generierungs- Strategie (uuid, autoIncrement oder ulid). Genau dieser Bezeichner ist mit den Parametern {{id}} der generierten Routen verbunden.
• Vererbung — ein Modell kann von einem übergeordneten Modell erben; das untergeordnete Modell zeigt die Eigenschaften des übergeordneten Modells schreibgeschützt zusätzlich zu seinen eigenen an.
• Speicherung & Lebenszyklus — erwartetes Volumen, Zeitstempel (created / updated) und weiches Löschen (Soft Delete).

Aus diesen Einstellungen heraus startet man auch CRUD generieren und Suchrouten generieren — beschrieben auf der nächsten Seite.