Modellek, enumok és tulajdonságok

A modellek írják le az API-ja adatait. Egy modell tipizált tulajdonságokat hordoz, és ezek a tulajdonságok hivatkozhatnak más modellekre vagy enumokra.

Az enumok

Egy enum egy zárt értékkészlet (például egy draft / published / archived állapot). Egy terv kétféleképpen kezeli őket:

• Nevesített enumok — újrafelhasználhatók, első osztályúak. Az Enumok szakaszban használja az Enum hozzáadása gombot, adjon neki nevet és leírást, majd az Érték hozzáadása gombbal minden bejegyzéshez. Egy tulajdonság (vagy egy útvonalparaméter) ezután a típusa révén hivatkozik rá.
• Beágyazott enumok — közvetlenül egy tulajdonságon deklarált névtelen készlet. Egy string / integer / number tulajdonságon az Enum-értékek zseton-szerkesztő lehetővé teszi, hogy az engedélyezett értékeket helyben felsorolja, nevesített típus létrehozása nélkül.

Amikor egy beágyazott enum megérdemli, hogy megosszák, a Kiemelés nevesített enummá előlépteti: létrehozza a nevesített enumot (egy azonos értékű meglévő enumot újrafelhasználva, a duplikátumok elkerülésére), és átírja a tulajdonságot, hogy arra hivatkozzon. Az útvonalparaméterek szintén hordoznak beágyazott enumokat és ugyanazt a Kiemelés műveletet — lásd Útvonalak és CRUD.

Egy modell tulajdonságai

A Modellek szakaszban válasszon ki egy modellt: a tulajdonságai egy táblázatban jelennek meg (Tulajdonság, Típus, Jelzők, Példa). Használja a Tulajdonság hozzáadása gombot egy létrehozásához.

Egy tulajdonság a következő típusú lehet:

• egy primitív: string, integer, number, boolean;
• egy tömb (array<…>) vagy egy map (map<…>) egy másik típusból;
• egy hivatkozás egy másik modellre;
• egy hivatkozás egy enumra.

Egy string esetén megadhat egy formátumot: email, uuid, date, date-time, uri, hostname, ipv4, password vagy byte.

A típuson túl egy tulajdonság számos mezőt elfogad: Leírás, Példa, Alapértelmezett érték, Minimum / Maximum, Minimális hossz / Maximális hossz, Minta (regex), Elavultsági üzenet, és — a hivatkozásoknál — egy On delete viselkedés.

A jelzők

A jelzők minősítik a tulajdonságot, és jelvények formájában jelennek meg: kötelező, nullable, unique, megváltoztathatatlan, searchable (lekérdezhető — lásd Útvonalak és CRUD), elavult, csak olvasható, csak írható, és PII (személyes adat).

Identitás és öröklődés

Minden modellnek saját beállításai vannak:

• Identitás — az azonosító tulajdonság és annak generálási stratégiája (uuid, autoIncrement vagy ulid). Éppen ez az azonosító kötődik a generált útvonalak {{id}} paramétereihez.
• Öröklődés — egy modell örökölhet egy szülőtől; a gyermek csak olvashatóként jeleníti meg a szülő tulajdonságait, a sajátjai mellett.
• Tárolás & életciklus — várható volumen, időbélyegek (created / updated) és lágy törlés (soft delete).

Ezekből a beállításokból is elindítható a CRUD generálása és a Keresési útvonalak generálása — a következő oldalon leírva.