El diseñador de API

El diseñador de API le permite diseñar una API completa directamente en Restorm: usted describe sus datos y sus rutas, y Restorm se encarga del resto — sirve su diseño como un verdadero servidor mock, y genera el código de su aplicación a partir de plantillas.

Es la herramienta ideal para arrancar una API antes de que exista el back-end: maquete el contrato, hágalo probar a sus clientes y mantenga todo versionado en su proyecto.

Un diseño, varias secciones

Un diseño se crea como cualquier otro elemento: clic derecho en una carpeta ▸ Añadir ▸ Diseño de API. Se abre en su propia pestaña y agrupa varias secciones, accesibles desde la barra lateral:

Sección	Para qué sirve
Modelos	Sus entidades y sus propiedades — véase Modelos, enums y propiedades.
Enums	Conjuntos de valores cerrados, reutilizables como tipo de propiedad.
Rutas	Los puntos de entrada de la API, agrupados por recurso — véase Rutas y CRUD.
Servidor	Servir el diseño como un mock, en HTTP, GraphQL, SOAP, OData o gRPC — véase Servir el diseño como mock.
Clientes	Peticiones listas para usar que llaman al mock en ejecución — véase Clientes.
Documentación y Notas	Documentación y notas libres adjuntas al diseño.
Código	La generación de código a partir de sus plantillas — véase Generación de código.

Los ajustes del diseño (nombre, valores por defecto) se abren haciendo clic directamente en el nodo del diseño en la barra lateral.

El recorrido típico

1. Describa sus datos — cree sus modelos y sus enums, añada sus propiedades, sus tipos y sus restricciones.
2. Defina sus rutas — a mano, o con un clic mediante Generar el CRUD desde un modelo.
3. Sirva el mock — inicie el servidor y apunte su aplicación o un cliente hacia él. El mismo diseño se proyecta automáticamente en cada protocolo activado.
4. Genere el código — elija una o varias plantillas (las suyas o las propuestas por Restorm) y produzca el proyecto correspondiente.

Cada paso se detalla en las páginas de esta sección.