API-designern

API-designern låter dig utforma ett komplett API direkt i Restorm: du beskriver dina data och dina rutter, Restorm sköter resten — det betjänar din design som en riktig mockserver, och det genererar koden till din applikation utifrån mallar.

Det är det idealiska verktyget för att starta ett API innan back-enden finns: skissa upp kontraktet, låt dina klienter testa det, och håll allt versionshanterat i ditt projekt.

En design, flera sektioner

En design skapas som vilket annat element som helst: högerklicka på en mapp ▸ Lägg till ▸ API-design. Den öppnas i sin egen flik och samlar flera sektioner, åtkomliga från sidofältet:

Sektion	Vad den används till
Modeller	Dina entiteter och deras egenskaper — se Modeller, enumar och egenskaper.
Enumar	Slutna uppsättningar av värden, återanvändbara som egenskapstyp.
Rutter	API:ets ingångspunkter, grupperade per resurs — se Rutter & CRUD.
Server	Betjäna designen som en mock, via HTTP, GraphQL, SOAP, OData eller gRPC — se Betjäna designen som mock.
Klienter	Färdiga förfrågningar som anropar den körande mocken — se Klienter.
Dokumentation & Anteckningar	Dokumentation och fria anteckningar kopplade till designen.
Kod	Kodgenereringen utifrån dina mallar — se Kodgenerering.

Designens inställningar (namn, standardvärden) öppnas genom att klicka direkt på designens nod i sidofältet.

Det typiska förloppet

1. Beskriv dina data — skapa dina modeller och dina enumar, lägg till deras egenskaper, deras typer och deras begränsningar.
2. Definiera dina rutter — för hand, eller med ett klick via Generera CRUD utifrån en modell.
3. Betjäna mocken — starta servern och rikta din applikation eller en klient mot den. Samma design projiceras automatiskt i varje aktiverat protokoll.
4. Generera koden — välj en eller flera mallar (dina egna eller de som Restorm erbjuder) och producera motsvarande projekt.

Varje steg beskrivs i detalj på sidorna i den här sektionen.