API-designeren

API-designeren lar deg designe et komplett API direkte i Restorm: du beskriver dataene og rutene dine, Restorm tar seg av resten — den serverer designet ditt som en ekte mockserver, og den genererer koden til applikasjonen din ut fra maler.

Det er det ideelle verktøyet for å starte et API før back-enden finnes: skisser kontrakten, la klientene dine teste den, og hold alt versjonshåndtert i prosjektet ditt.

Ett design, flere seksjoner

Et design opprettes som et hvilket som helst annet element: høyreklikk på en mappe ▸ Legg til ▸ API-design. Det åpnes i sin egen fane og samler flere seksjoner, tilgjengelige fra sidefeltet:

Seksjon	Hva den brukes til
Modeller	Entitetene dine og egenskapene deres — se Modeller, enums og egenskaper.
Enums	Lukkede sett med verdier, gjenbrukbare som egenskapstype.
Ruter	API-ets inngangspunkter, gruppert etter ressurs — se Ruter & CRUD.
Server	Server designet som en mock, via HTTP, GraphQL, SOAP, OData eller gRPC — se Server designet som mock.
Klienter	Klar-til-bruk-forespørsler som kaller den kjørende mocken — se Klienter.
Dokumentasjon & Notater	Dokumentasjon og frie notater knyttet til designet.
Kode	Kodegenereringen ut fra malene dine — se Kodegenerering.

Designets innstillinger (navn, standardverdier) åpnes ved å klikke direkte på designnoden i sidefeltet.

Det typiske forløpet

1. Beskriv dataene dine — opprett modellene og enums dine, legg til egenskapene deres, typene deres og begrensningene deres.
2. Definer rutene dine — for hånd, eller med ett klikk via Generer CRUD ut fra en modell.
3. Server mocken — start serveren og pek applikasjonen din eller en klient mot den. Det samme designet projiseres automatisk i hver aktiverte protokoll.
4. Generer koden — velg en eller flere maler (dine egne eller de Restorm tilbyr) og produser det tilsvarende prosjektet.

Hvert trinn er beskrevet i detalj på sidene i denne seksjonen.