Designerul de API

Designerul de API vă permite să proiectați o API completă direct în Restorm: descrieți datele și rutele, iar Restorm se ocupă de rest — servește designul dumneavoastră ca un adevărat server mock și generează codul aplicației dumneavoastră pornind de la șabloane.

Este instrumentul ideal pentru a demara o API înainte ca back-end-ul să existe: schițați contractul, dați-l spre testare clienților și păstrați totul versionat în proiectul dumneavoastră.

Un design, mai multe secțiuni

Un design se creează ca orice alt element: clic dreapta pe un dosar ▸ Adăugați ▸ Design de API. Se deschide în propria filă și grupează mai multe secțiuni, accesibile din bara laterală:

Secțiune	La ce servește
Modele	Entitățile dumneavoastră și proprietățile lor — vedeți Modele, enum-uri și proprietăți.
Enum-uri	Seturi de valori închise, reutilizabile ca tip de proprietate.
Rute	Punctele de intrare ale API-ului, grupate pe resursă — vedeți Rute și CRUD.
Server	Servirea designului ca mock, în HTTP, GraphQL, SOAP, OData sau gRPC — vedeți Servirea designului ca mock.
Clienți	Cereri gata de utilizare care apelează mock-ul în execuție — vedeți Clienți.
Documentație și Note	Documentație și note libere atașate designului.
Cod	Generarea de cod pornind de la șabloanele dumneavoastră — vedeți Generarea de cod.

Setările designului (nume, valori implicite) se deschid făcând clic direct pe nodul designului în bara laterală.

Parcursul tipic

1. Descrieți datele — creați modelele și enum-urile, adăugați-le proprietățile, tipurile și constrângerile.
2. Definiți rutele — manual, sau cu un clic prin Generați CRUD-ul dintr-un model.
3. Serviți mock-ul — porniți serverul și îndreptați aplicația sau un client către el. Același design este proiectat automat în fiecare protocol activat.
4. Generați codul — alegeți unul sau mai multe șabloane (ale dumneavoastră sau cele propuse de Restorm) și produceți proiectul corespunzător.

Fiecare pas este detaliat în paginile acestei secțiuni.