Gå til indhold

API-designeren

API-designeren lader dig designe et komplet API direkte i Restorm: du beskriver dine data og dine ruter, Restorm klarer resten — det serverer dit design som en rigtig mockserver, og det genererer koden til din applikation ud fra skabeloner.

Det er det ideelle værktøj til at starte et API, før back-enden findes: skitser kontrakten, lad dine klienter teste det, og hold det hele versionsstyret i dit projekt.

Overblik over API-designeren: sidepanelet viser modellerne, enums, ruterne, serveren, klienterne og koden

Et design oprettes som ethvert andet element: højreklik på en mappe ▸ Tilføj ▸ API-design. Det åbnes i sin egen fane og samler flere sektioner, tilgængelige fra sidepanelet:

SektionHvad den bruges til
ModellerDine entiteter og deres egenskaber — se Modeller, enums og egenskaber.
EnumsLukkede sæt af værdier, genanvendelige som egenskabstype.
RuterAPI’ets indgangspunkter, grupperet efter ressource — se Ruter & CRUD.
ServerServer designet som en mock, via HTTP, GraphQL, SOAP, OData eller gRPC — se Server designet som mock.
KlienterKlar-til-brug-forespørgsler, der kalder den kørende mock — se Klienter.
Dokumentation & NoterDokumentation og frie noter tilknyttet designet.
KodeKodegenereringen ud fra dine skabeloner — se Kodegenerering.

Designets indstillinger (navn, standardværdier) åbnes ved at klikke direkte på designets knude i sidepanelet.

  1. Beskriv dine data — opret dine modeller og dine enums, tilføj deres egenskaber, deres typer og deres begrænsninger.
  2. Definer dine ruter — i hånden, eller med et klik via Generer CRUD ud fra en model.
  3. Server mocken — start serveren og peg din applikation eller en klient mod den. Det samme design projiceres automatisk i hver aktiveret protokol.
  4. Generer koden — vælg en eller flere skabeloner (dine egne eller dem, Restorm tilbyder) og producer det tilsvarende projekt.

Hvert trin er beskrevet i detaljer på siderne i denne sektion.