Il designer di API

Il designer di API Le permette di progettare un’API completa direttamente in Restorm: descriva i suoi dati e le sue rotte, e Restorm si occupa del resto — serve il suo design come un vero server mock, e genera il codice della sua applicazione a partire da template.

È lo strumento ideale per avviare un’API prima che il back-end esista: abbozzi il contratto, lo faccia testare ai suoi clienti e mantenga tutto versionato nel suo progetto.

Un design, più sezioni

Un design si crea come qualsiasi altro elemento: clic destro su una cartella ▸ Aggiungi ▸ Design di API. Si apre nella sua scheda dedicata e raggruppa più sezioni, accessibili dalla barra laterale:

Sezione	A cosa serve
Modelli	Le sue entità e le loro proprietà — vedi Modelli, enum e proprietà.
Enum	Insiemi di valori chiusi, riutilizzabili come tipo di proprietà.
Rotte	I punti d’ingresso dell’API, raggruppati per risorsa — vedi Rotte e CRUD.
Server	Servire il design come un mock, in HTTP, GraphQL, SOAP, OData o gRPC — vedi Servire il design come mock.
Client	Richieste pronte all’uso che chiamano il mock in esecuzione — vedi Client.
Documentazione e Note	Documentazione e note libere allegate al design.
Codice	La generazione di codice a partire dai suoi template — vedi Generazione di codice.

Le impostazioni del design (nome, valori predefiniti) si aprono cliccando direttamente sul nodo del design nella barra laterale.

Il percorso tipico

1. Descriva i suoi dati — crei i suoi modelli e i suoi enum, aggiunga le loro proprietà, i loro tipi e i loro vincoli.
2. Definisca le sue rotte — a mano, o con un clic tramite Genera il CRUD a partire da un modello.
3. Serva il mock — avvii il server e punti la sua applicazione o un client su di esso. Lo stesso design viene proiettato automaticamente in ogni protocollo attivato.
4. Generi il codice — scelga uno o più template (i suoi o quelli proposti da Restorm) e produca il progetto corrispondente.

Ogni passo è dettagliato nelle pagine di questa sezione.