Modelos, enums y propiedades

Los modelos describen los datos de su API. Un modelo lleva propiedades tipadas, y esas propiedades pueden referenciar otros modelos o enums.

Los enums

Un enum es un conjunto de valores cerrado (por ejemplo un estado draft / published / archived). Un diseño los gestiona de dos maneras:

• Enums con nombre — reutilizables, de primer nivel. Desde la sección Enums, use Añadir un enum, déle un nombre y una descripción, y luego Añadir un valor para cada entrada. Una propiedad (o un parámetro de ruta) lo referencia luego por su tipo.
• Enums inline — un conjunto anónimo declarado directamente en una propiedad. En una propiedad string / integer / number, un editor de chips Valores de enum le permite enumerar los valores permitidos allí mismo, sin crear un tipo con nombre.

Cuando un enum inline merece ser compartido, Extraer a un enum con nombre lo promueve: crea el enum con nombre (reutilizando un enum existente con los mismos valores, para evitar duplicados) y reescribe la propiedad para que lo referencie. Los parámetros de ruta llevan también enums inline y la misma acción Extraer — véase Rutas y CRUD.

Las propiedades de un modelo

En la sección Modelos, seleccione un modelo: sus propiedades se muestran en una tabla (Propiedad, Tipo, Banderas, Ejemplo). Use Añadir una propiedad para crear una.

Una propiedad puede ser de tipo:

• un primitivo: string, integer, number, boolean;
• un array (array<…>) o un map (map<…>) de otro tipo;
• una referencia hacia otro modelo;
• una referencia hacia un enum.

Para un string, puede precisar un formato: email, uuid, date, date-time, uri, hostname, ipv4, password o byte.

Más allá del tipo, una propiedad acepta numerosos campos: Descripción, Ejemplo, Valor por defecto, Mínimo / Máximo, Longitud mín / Longitud máx, Patrón (regex), Mensaje de obsolescencia, y — para las referencias — un comportamiento On delete.

Las banderas

Unas banderas califican la propiedad y se muestran en forma de insignias: requerida, nullable, única, inmutable, searchable (consultable — véase Rutas y CRUD), obsoleta, solo lectura, solo escritura, y PII (dato personal).

Identidad y herencia

Cada modelo tiene sus propios ajustes:

• Identidad — la propiedad identificadora y su estrategia de generación (uuid, autoIncrement o ulid). Es este identificador el que se vincula a los parámetros {{id}} de las rutas generadas.
• Herencia — un modelo puede heredar de un padre; el hijo muestra las propiedades del padre en solo lectura, además de las suyas.
• Almacenamiento y ciclo de vida — volumetría esperada, marcas de tiempo (created / updated) y borrado lógico (soft delete).

También es desde estos ajustes desde donde se lanza Generar el CRUD y Generar las rutas de búsqueda — descritos en la página siguiente.