Mallit, enumit ja ominaisuudet

Mallit kuvaavat API:si datan. Malli kantaa tyypitettyjä ominaisuuksia, ja nämä ominaisuudet voivat viitata toisiin malleihin tai enumeihin.

Enumit

Enum on suljettu arvojoukko (esimerkiksi tila draft / published / archived). Suunnitelma käsittelee niitä kahdella tavalla:

• Nimetyt enumit — uudelleenkäytettäviä, ensiluokkaisia. Enumit-osiossa käytä Lisää enum, anna sille nimi ja kuvaus, ja käytä sitten Lisää arvo jokaiselle merkinnälle. Ominaisuus (tai reittiparametri) viittaa siihen sen jälkeen tyyppinsä kautta.
• Inline-enumit — nimetön joukko, joka määritellään suoraan yhdellä ominaisuudella. string / integer / number -ominaisuudella Enum-arvot-merkkieditori antaa sinun luetella sallitut arvot paikan päällä, ilman nimetyn tyypin luomista.

Kun inline-enum ansaitsee tulla jaetuksi, Erota nimetyksi enumiksi ylentää sen: se luo nimetyn enumin (käyttäen uudelleen samat arvot sisältävää olemassa olevaa enumia, jotta vältetään kaksoiskappaleet) ja kirjoittaa ominaisuuden uudelleen viittaamaan siihen. Reittiparametrit kantavat myös inline-enumeja ja saman Erota-toiminnon — katso Reitit ja CRUD.

Mallin ominaisuudet

Valitse Mallit-osiossa malli: sen ominaisuudet näytetään taulukossa (Ominaisuus, Tyyppi, Liput, Esimerkki). Käytä Lisää ominaisuus luodaksesi sellaisen.

Ominaisuus voi olla tyyppiä:

• primitiivi: string, integer, number, boolean;
• taulukko (array<…>) tai map (map<…>) toisesta tyypistä;
• viittaus toiseen malliin;
• viittaus enumiin.

string-tyypille voit määrittää formaatin: email, uuid, date, date-time, uri, hostname, ipv4, password tai byte.

Tyypin lisäksi ominaisuus hyväksyy lukuisia kenttiä: Kuvaus, Esimerkki, Oletusarvo, Minimi / Maksimi, Vähimmäispituus / Enimmäispituus, Kuvio (regex), Vanhentumisviesti, ja — viittauksille — On delete -käyttäytyminen.

Liput

Liput luonnehtivat ominaisuutta ja näytetään merkkeinä: pakollinen, nullable, unique, muuttumaton, searchable (haettavissa — katso Reitit ja CRUD), vanhentunut, vain luku, vain kirjoitus, ja PII (henkilötieto).

Identiteetti ja periytyminen

Jokaisella mallilla on omat asetuksensa:

• Identiteetti — yksilöivä ominaisuus ja sen generoinnin strategia (uuid, autoIncrement tai ulid). Juuri tämä tunniste kytketään generoitujen reittien {{id}}-parametreihin.
• Periytyminen — malli voi periä vanhemmalta; lapsi näyttää vanhemman ominaisuudet vain luku -tilassa omiensa lisäksi.
• Tallennus & elinkaari — odotettu volyymi, aikaleimat (created / updated) ja pehmeä poisto (soft delete).

Näistä asetuksista käynnistetään myös Generoi CRUD ja Generoi hakureitit — kuvattu seuraavalla sivulla.